Java String Concatenation and Performance
18 comments Published by Venish Joe on Sunday, November 08, 2009The quick and dirty way to concatenate strings in Java is to use the concatenation operator (+). This will yield a reasonable performance if you need to combine two or three strings (fixed-size). But if you want to concatenate n strings in a loop, the performance degrades in multiples of n. Given that String is immutable, for large number of string concatenation operations, using (+) will give us a worst performance. But how bad ? How StringBuffer, StringBuilder or String.concat() performs if we put them on a performance test ?. This article will try to answer those questions.
We will be using Perf4J to calculate the performance, since this library will give us aggregated performance statistics like mean, minimum, maximum, standard deviation over a set time span. In the code, we will concatenate a string (*) repeatedly 50,000 times and this iteration will be performed 21 times so that we can get a good standard deviation. The following methods will be used to concatenate strings.
- Concatenation Operator (+)
- String concat method - concat(String str)
- StringBuffer append method - append(String str)
- StringBuilder append method - append(String str)
And finally we will look at the byte code to see how each of these operations perform. Let’s start building the class. Note that each of the block in the code should be wrapped around the Perf4J library to calculate the performance in each iteration. Let’s define the outer and inner iterations first.
private static final int OUTER_ITERATION=20; private static final int INNER_ITERATION=50000;
Now let’s implement each of the four methods mentioned in the article. Nothing fancy here, plain implementations of (+), String.concat(), StringBuffer.append() & StringBuilder.append().
String addTestStr = "";
String concatTestStr = "";
StringBuffer concatTestSb = null;
StringBuilder concatTestSbu = null;
for (int outerIndex=0;outerIndex<=OUTER_ITERATION;outerIndex++) {
StopWatch stopWatch = new LoggingStopWatch("StringAddConcat");
addTestStr = "";
for (int innerIndex=0;innerIndex<=INNER_ITERATION;innerIndex++)
addTestStr += "*";
stopWatch.stop();
}
for (int outerIndex=0;outerIndex<=OUTER_ITERATION;outerIndex++) {
StopWatch stopWatch = new LoggingStopWatch("StringConcat");
concatTestStr = "";
for (int innerIndex=0;innerIndex<=INNER_ITERATION;innerIndex++)
concatTestStr = concatTestStr.concat("*");
stopWatch.stop();
}
for (int outerIndex=0;outerIndex<=OUTER_ITERATION;outerIndex++) {
StopWatch stopWatch = new LoggingStopWatch("StringBufferConcat");
concatTestSb = new StringBuffer();
for (int innerIndex=0;innerIndex<=INNER_ITERATION;innerIndex++)
concatTestSb.append("*");
stopWatch.stop();
}
for (int outerIndex=0;outerIndex<=OUTER_ITERATION;outerIndex++) {
StopWatch stopWatch = new LoggingStopWatch("StringBuilderConcat");
concatTestSbu = new StringBuilder();
for (int innerIndex=0;innerIndex<=INNER_ITERATION;innerIndex++)
concatTestSbu.append("*");
stopWatch.stop();
}Let’s run this program and generate the performance metrics. I ran this program in a 64-bit OS (Windows 7), 32-bit JVM (7-ea), Core 2 Quad CPU (2.00 GHz) with 4 GB RAM.
The output from the 21 iterations of the program is plotted below.
Well, the results are pretty conclusive and as expected. One interesting point to notice is how better String.concat performs. We all know String is immutable, then how the performance of concat is better. To answer the question we should look at the byte code. I have included the whole byte code in the download package, but let’s have a look at the below snippet.
45: new #7; //class java/lang/StringBuilder
48: dup
49: invokespecial #8; //Method java/lang/StringBuilder."<init>":()V
52: aload_1
53: invokevirtual #9; //Method java/lang/StringBuilder.append:
(Ljava/lang/String;)Ljava/lang/StringBuilder;
56: ldc #10; //String *
58: invokevirtual #9; //Method java/lang/StringBuilder.append:
(Ljava/lang/String;)Ljava/lang/StringBuilder;
61: invokevirtual #11; //Method java/lang/StringBuilder.toString:()
Ljava/lang/String;
64: astore_1
This is the byte code for String.concat(), and its clear from this that the String.concat is using StringBuilder for concatenation and the performance should be as good as String Builder. But given that the source object being used is String, we do have some performance loss in String.concat.
So for the simple operations we should use String.concat compared to (+), if we don’t want to create a new instance of StringBuffer/Builder. But for huge operations, we shouldn’t be using the concat operator, as seen in the performance results it will bring down the application to its knees and spike up the CPU utilization. To have the best performance, the clear choice is StringBuilder as long as you do not need thread-safety or synchronization.
The full source code, compiled class & the byte code is available for download in the below link.
Download Source, Class & Byte Code: String_Concatenation _Performance.zip
Recursive File Tree Traversing in Java using NIO.2
0 comments Published by Venish Joe on Monday, October 26, 2009In my previous article about NIO.2, we have seen how to implement a service which monitors a directory recursively for any changes. In this article we will look at another improvement in JDK7 (NIO.2) called FileWatcher. This will allow us to implement a search or index. For example, we can find all the *some_pattern* files in a given directory recursively and (or) delete / copy all the all the *some_pattern* files in a file system. In a nutshell FileWatcher will get us a list of files from a file system based on a pattern which can be processed based on our requirement.
The FileVistor is an interface and our class should implement it. We have two methods before the traversal starts at the directory level & file level, and one method after the traversal is complete, which can be used for clean up or post processing. The important points from the interface is given in the below diagram.
While I think FileVistor is the best way to handle this, JDK7 NIO.2 has given another option to achieve the same, a class named SimpleFileVistor (which implements FileVisitor). It should be self explanatory, a simplified version of FileVisitor. We can extend the SimpileFileVisitor into our class and then traverse the directory with overriding only the methods we need, and if any step fails we will get an IOException.
According to me, FileVisitor is better because it forces you to implement the methods (sure, you can leave them blank) since these methods are really important if you plan to implement recursive delete / copy or work with symbolic links. For example, if you are copying some files to a directory you should make sure that the directory should be created first before copying which can be done in the preVisitDirectory().
The other area of concern is symbolic links and how this will be handled by FileVisitor. This can be achieved using FileVisitOption enums. By default, the symbolic links are not followed so that we are not accidentally deleting any directories in a recursive delete. If you want to handle manually, there are two options FOLLOW_LINKS (follow the links) & DETECT_CYCLES (catch circular references).
If you want to exclude some directory from FileVisitor or if you are looking for a directory or a file in the file system and once you find it you want to stop searching that can be implemented by using the return type of FileVisitor, called FileVisitResult. SKIP_SUBTREE allows us to skip directories & subdirectories. TERMINATE stops the traversing.
The search can be initiated by the walkFileTree() method in Files class. This will take the starting directory (or root directory in your search) as a parameter. You can also define Integer.MAX_VALUE if you want to manually specify the depth. And as mentioned in the above diagram, define FileVisitOption for symbolic links if needed.
Enough with the API description, let's write some sample code to implement what we discussed. We will be using the SimpleFileVisitor so that in our demo we don’t need to implement all the methods.
Let’s start with defining the pattern which needs to be searched for. In this example, we will search for all the *txt file / directory names recursively in any given directory. This can be done with getPathMatcher() in FileSystems
PathMatcher pathMatcher = FileSystems.getDefault().getPathMatcher("glob:" + "*txt*");Now, let’s initiate the search by calling walkFileTree() as mentioned below. We are not defining anything specific for symbolic links so, by default its NO_FOLLOW.
Files.walkFileTree(Paths.get("D://Search"), fileVisitor);Let’s go through the implementations of class SimpleFileVisitor, we will be overriding only visitFile() & preVisitDirectory() in this example, but its a good practice to override all the five methods so that we have more control over the search. The implementation is pretty simple, based on the pattern the below methods will search for a directory or file and print the path.
@Override
public FileVisitResult visitFile(Path filePath, BasicFileAttributes basicFileAttributes) {
if (filePath.getName() != null && pathMatcher.matches(filePath.getName()))
System.out.println("FILE: " + filePath);
return FileVisitResult.CONTINUE;
}
@Override
public FileVisitResult preVisitDirectory(Path directoryPath) {
if (directoryPath.getName() != null && pathMatcher.matches(directoryPath.getName()))
System.out.println("DIR: " + directoryPath);
return FileVisitResult.CONTINUE;
}Once this is completed, we can use the postVisitDirectory() to perform additional tasks or any cleanup if needed. A sample output from my machine is given below.
The complete source code is given below. Please note that you need JDK7 to run this code. I have also given a link to download the compiled class along with source.
Download Source & Class: NIO2_FileVisitor.zip
Complete Source Code.
public class NIO2_FileVisitor extends SimpleFileVisitor<Path> {
private PathMatcher pathMatcher;
@Override
public FileVisitResult visitFile(Path filePath,
BasicFileAttributes basicFileAttributes) {
if (filePath.getName() != null &&
pathMatcher.matches(filePath.getName()))
System.out.println("FILE: " + filePath);
return FileVisitResult.CONTINUE;
}
@Override
public FileVisitResult preVisitDirectory(Path directoryPath) {
if (directoryPath.getName() != null &&
pathMatcher.matches(directoryPath.getName()))
System.out.println("DIR: " + directoryPath);
return FileVisitResult.CONTINUE;
}
public static void main(String[] args) throws IOException {
NIO2_FileVisitor fileVisitor = new NIO2_FileVisitor();
fileVisitor.pathMatcher = FileSystems.getDefault().
getPathMatcher("glob:" + "*txt*");
Files.walkFileTree(Paths.get("D://Search"), fileVisitor);
}
}Dynamically Load Compiled Java Class as a Byte Array and Execute
4 comments Published by Venish Joe on Wednesday, October 21, 2009As we know, all the compiled java classes runs inside the JVM. The default class loader from Sun loads the classes into JVM and executes it. This class loader is a part of JVM which loads the compiled byte code to memory. In this article, I will show how to convert a compiled java class to a array of bytes and then load these array of bytes into another class (which can be over the network) and execute the array of bytes.
So the question arises, why should we write a custom class loader ? There are some distinct advantages. Some of them below
- We can load a class over any network protocol. Since the java class can be converted to a series of numbers (array of bytes), we can use most of the protocols.
- Load Dynamic classes based on the type of user, especially useful when you want to validate the license of your software over the web and if you are paranoid about the security.
- More flexible and secure, you can encrypt the byte stream (asymmetric or symmetric) ensuring safer delivery.
For this article we will be creating three classes
- JavaClassLoader – The custom class loader which will load the array of bytes and execute. In other words, the client program.
- Class2Byte – The Java class which converts any compiled class / object to a array of bytes
- ClassLoaderInput – The class which will be converted to array of bytes and transferred
Let’s divide this article into two sections, in the fist section we will convert the java class to array of bytes and in the second section, we will load that array.
Create & Convert the Java class to array of bytes
Let’s write a simple class (ClassLoaderInput) which just prints a line. This is the class which will be converted to a byte array.
public class ClassLoaderInput {
public void printString() {
System.out.println("Hello World!");
}
}Now, let’s write another class (Class2Byte) which will convert the ClassLoaderInput to a byte of array. The concept to convert the file is simple, compile the above file and load the class file through input stream and with an offset read and convert the class to bytes and write the output in to another out stream. We need these bytes as a comma separated value, so we will use StringBuffer to add comma between the bytes.
int _offset=0;
int _read=0;
File fileName = new File(args [0]);
InputStream fileInputStream = new FileInputStream(fileName);
FileOutputStream fileOutputStream = new FileOutputStream(args[1]);
PrintStream printStream = new PrintStream(fileOutputStream);
StringBuffer bytesStringBuffer = new StringBuffer();
byte[] byteArray = new byte[(int)fileName.length()];
while (_offset < byteArray.length &&
(_read=fileInputStream.read(byteArray, _offset,
byteArray.length-_offset)) >= 0)
_offset += _read;
fileInputStream.close();
for (int index = 0; index < byteArray.length; index++)
bytesStringBuffer.append(byteArray[index]+",");
printStream.print(bytesStringBuffer.length()==0 ? "" :
bytesStringBuffer.substring(0, bytesStringBuffer.length()-1));Now let’s run this file and generate the output. A sample output from my machine is below.
Now,we have the sample class (ClassLoaderInput) file as a bunch of numbers. Now this bunch of numbers can be transferred over any protocol to our custom class loader which will “reconstruct” the class from these bytes and run it, without any physical trace in the client machine (the array of bytes will be on memory).
Load the array of bytes and execute
Now, to the important part of this article, we are going to write a custom class loader which will load those bunch of numbers (array) and execute them. The array of bytes can be transferred over the network but in this example, we will define it as a string in the class loader for demonstration purpose.
Let’s start by defining the array of bytes.
private int[] data = {-54,-2,-70,-66,0,0,0,51,0,31,10,0,6,0,17,9,0,18,0,19,8,
0,20,10,0,21,0,22,7,0,23,7,0,24,1,0,6,60,105,110,105,116,62,1,0,3,40,41,86,1,
0,4,67,111,100,101,1,0,15,76,105,110,101,78,117,109,98,101,114,84,97,98,108,
101,1,0,18,76,111,99,97,108,86,97,114,105,97,98,108,101,84,97,98,108,101,1,0,
4,116,104,105,115,1,0,18,76,67,108,97,115,115,76,111,97,100,101,114,73,110,
112,117,116,59,1,0,11,112,114,105,110,116,83,116,114,105,110,103,1,0,10,83,
111,117,114,99,101,70,105,108,101,1,0,21,67,108,97,115,115,76,111,97,100,101,
114,73,110,112,117,116,46,106,97,118,97,12,0,7,0,8,7,0,25,12,0,26,0,27,1,0,
12,72,101,108,108,111,32,87,111,114,108,100,33,7,0,28,12,0,29,0,30,1,0,16,67,
108,97,115,115,76,111,97,100,101,114,73,110,112,117,116,1,0,16,106,97,118,97,
47,108,97,110,103,47,79,98,106,101,99,116,1,0,16,106,97,118,97,47,108,97,110,
103,47,83,121,115,116,101,109,1,0,3,111,117,116,1,0,21,76,106,97,118,97,47,105,
111,47,80,114,105,110,116,83,116,114,101,97,109,59,1,0,19,106,97,118,97,47,105,
111,47,80,114,105,110,116,83,116,114,101,97,109,1,0,7,112,114,105,110,116,108,
110,1,0,21,40,76,106,97,118,97,47,108,97,110,103,47,83,116,114,105,110,103,59,
41,86,0,33,0,5,0,6,0,0,0,0,0,2,0,1,0,7,0,8,0,1,0,9,0,0,0,47,0,1,0,1,0,0,0,5,42,
-73,0,1,-79,0,0,0,2,0,10,0,0,0,6,0,1,0,0,0,1,0,11,0,0,0,12,0,1,0,0,0,5,0,12,0,
13,0,0,0,1,0,14,0,8,0,1,0,9,0,0,0,55,0,2,0,1,0,0,0,9,-78,0,2,18,3,-74,0,4,-79,
0,0,0,2,0,10,0,0,0,10,0,2,0,0,0,3,0,8,0,4,0,11,0,0,0,12,0,1,0,0,0,9,0,12,0,13,
0,0,0,1,0,15,0,0,0,2,0,16};The conversion of these bytes to class is done by the ClassLoader.defineClass() method We should supply the stream of bytes that make up the class data. The bytes in positions off through off+len-1 should have the format of a valid class file as defined by the Java Virtual Machine Specification. The offset and length will be the additional parameters. Once the defineClass converts the array to class, then we can use reflection to execute the methods in the class.
JavaClassLoader _classLoader = new JavaClassLoader();
byte[] rawBytes = new byte[_classLoader.data.length];
for (int index = 0; index < rawBytes.length; index++)
rawBytes[index] = (byte) _classLoader.data[index];
Class regeneratedClass = _classLoader.defineClass(args[0],
rawBytes, 0, rawBytes.length);
regeneratedClass.getMethod(args[1], null).invoke(null, new Object[] { args });Now, let’s compile the class loader and run. The the class file name & method name should be passed as a run time argument. If you have done everything right, you should see the output from the input class which we created (ClassLoaderInput) initially. Sample output from my machine below.
The precompiled classes and the source code can be downloaded from the below location.
Download Source & Class: Java_Dynamic_Class_Byte_Array.zip
Monitor a Directory for Changes using Java
7 comments Published by Venish Joe on Sunday, October 18, 2009Many applications which we use on a day to day basis like a music organizer, file editors monitor the directory for any changes in the files/directories and take appropriate action in the application if there are any changes detected on the fly. Since Java do not have direct access to the system level calls (unless we use JNI, which will make the code platform specific) the only way to monitor any directory is to use a separate thread which will be using a lot of resources (memory & disk I/O) to monitor the changes inside the directory. If we have sub-directories and need a recursive monitor, then the thread becomes more resource intensive.
There was a JSR (Java Specification Request) requested to add / rewrite more I/O APIs for Java platform. This was implemented in JDK 7 as JSR 203 with support for APIs like file system access, scalable asynchronous I/O operations, socket-channel binding and configuration, and multicast datagram's.
JSR 203 is one of the big feature for JDK 7 (Developer Preview is available in java.sun.com) and its been implemented as the second I/O package is java, called as NIO.2. I will be looking into more of these packages in future posts, but in this, I will show how to monitor a directory and its sub-directories for any changes using NIO.2 (JDK 7).
The APIs which we will be using WatchService (A watch service that watches registered objects for changes and events), WatchKey (A token representing the registration of a watchable object with a WatchService) & WatchEvent (An event or a repeated event for an object that is registered with a WatchService) to monitor a directory. So, without further explanation, let’s start working on the code.
Please note that you need JDK 7 to run this program. While writing this post, JDK 7 is available as a EA (Early Access) in Java Early Access Downloads page. Download the JDK and install it.
The first step is to get a directory to monitor. Path is one of the new I/O API as a part of NIO.2 which gives us more control over the I/O. So let’s get the directory to watch, if you want to watch the directory recursively then there should be another boolean flag defined, but in this example we will watch only the parent directory.
Path _directotyToWatch = Paths.get(args[0]);
Now let’s create a Watch service to the above directory and add a key to the service. In the watch key we can define what are all the events we need to look for. In this example we will monitor Create, Delete & Rename/Modify of the files or directories in the path.
WatchService watcherSvc = FileSystems.getDefault().newWatchService(); WatchKey watchKey = _directotyToWatch.register(watcherSvc, ENTRY_CREATE, ENTRY_DELETE, ENTRY_MODIFY);
Now we have all the variables defined. Let’s start a infinite loop to monitor the directory for any changes using WatchEvent. We will poll events in the directory and once some event is triggered (based on the WatchKey definition) we will print the type of event occurred and the name of the file/directory on which the event occurred. Once done, we will reset the watch key.
while (true) {
watchKey=watcherSvc.take();
for (WatchEvent<?> event: watchKey.pollEvents()) {
WatchEvent<Path> watchEvent = castEvent(event);
System.out.println(event.kind().name().toString() + " "
+ _directotyToWatch.resolve(watchEvent.context()));
watchKey.reset();
}
} Now to make the WatchEvent <Path> work, we should create a small utility as below ( this is the castEvent which is used in the above code).
static <T> WatchEvent<T> castEvent(WatchEvent<?> event) {
return (WatchEvent<T>)event;
}Now compile the file and give a directory as a runtime parameter while running it. Once the program starts running, start creating some directories/files or modify/rename some files in the directory which you gave as a parameter, the program will start triggering the event and you should be able to watch the modifications in the console. A sample output from my machine is below.
The full source code of the application is given below. You can also download the compiled class and code.
Download Source & Class: JSR203_NIO2_WatchFolder.zip
import java.nio.file.*;
import static java.nio.file.StandardWatchEventKind.*;
static <T> WatchEvent<T> castEvent(WatchEvent<?> event) {
return (WatchEvent<T>)event;
}
public static void main (String args[]) throws Exception {
Path _directotyToWatch = Paths.get(args[0]);
WatchService watcherSvc = FileSystems.getDefault().newWatchService();
WatchKey watchKey = _directotyToWatch.register(watcherSvc,
ENTRY_CREATE, ENTRY_DELETE, ENTRY_MODIFY);
while (true) {
watchKey=watcherSvc.take();
for (WatchEvent<?> event: watchKey.pollEvents()) {
WatchEvent<Path> watchEvent = castEvent(event);
System.out.println(event.kind().name().toString() + " "
+ _directotyToWatch.resolve(watchEvent.context()));
watchKey.reset();
}
}
}Signing Java Objects for Secure Transfer
4 comments Published by Venish Joe on Tuesday, October 13, 2009In distributed J2EE applications or in any application where you need to transfer Java objects to another system then there is always a security risk where the object can be intercepted which can result in data theft/loss. Especially in Serialization, (where the object is a physical file in the native file system) when the serialized Java objects are sent through the network, whoever knows the type of the object can always read it.
In this article, we will build two simple applications, one which generates the object, the keys (public & private) and signs the object with the private key. Other application which verifies the signed object in other end over the network or another application in the same machine. Both these apps can run independently in different machines. For signing the object we will be using Public-Key cryptography. This is one of the most widely used standards to sign data along with DSA & SHA1PRNG (cryptographically strong pseudo-random number generator (PRNG)). Public-Key cryptography is a asymmetric key algorithm, where the key used to encrypt a message is not the same as the key used to decrypt it.
This is the class diagram of the applications which we will be building. This article will be divided into two parts, the first part we will sign the object (serialized) and in the second part, we will verify it.

1. Sign the Java Object
First of all we need a class which will generate a public & private key. We will create a class named SecurityUtil which will generate those based on DSA (we can use RSA or any other algorithm as long as its available) and we will generate a cryptographically strong pseudo-random number generator (PRNG) which can be clubbed along with DSA (SHA1PRNG). The strength of the key will be 1024.
protected KeyPair generateKey () throws Exception {
KeyPairGenerator keyPairGen = KeyPairGenerator.getInstance("DSA");
SecureRandom secureRandom = SecureRandom.getInstance("SHA1PRNG");
keyPairGen.initialize(1024,secureRandom);
KeyPair keyPair = keyPairGen.generateKeyPair();
return keyPair;
}Next we will create a class named EmployeeValueObject which is nothing but a POJO with a HashMap getter/setter. This will be the object which we will be transferring over the network/application. Since we serialize the object before transferring, this class should implement Serializable.
public class EmployeeValueObject implements Serializable {
HashMap employeeSalary = new HashMap();
public void setSalary (HashMap employeeSalary){
this.employeeSalary = employeeSalary;
}
public HashMap getSalary () {
return employeeSalary;
}
}Now we have all the supporting classes which we need and let’s start building the main application. Let’s call this class EmployeeDetails and this will create an object for the POJO which we created in our previous step and populate with some data. In addition to that, we will sign the POJO object and then serialize to a file. In this example we will be also serializing the public key to transfer to the other end. (Note: In production implementations, both these objects shouldn’t be sent at the same time. The application at the other end should already have the public key)
Let’s create the POJO and populate with some data in the HashMap.
EmployeeValueObject employeeVO = new EmployeeValueObject();
employeeVO.setSalary(populateData());
private static HashMap populateData (){
HashMap employeeSalary = new HashMap ();
employeeSalary.put("3", "Johns, Galvin D. --> $18,000");
employeeSalary.put("4", "Weber, Murphy I. --> $5,000");
return employeeSalary;
}Now let’s generate the public & private keys from SecutityUtil and sign the POJO which we created in the above step.
KeyPair keyPair = new SecurityUtil().generateKey(); PrivateKey privateKey = keyPair.getPrivate(); PublicKey publicKey = keyPair.getPublic(); Signature digitalSignature = Signature.getInstance(privateKey.getAlgorithm()); SignedObject digitalSignedObj = new SignedObject(employeeVO, privateKey, digitalSignature);
Now digitalSignedObj is a digitally signed data with the private key which we generated. Now let’s serialize this object for the secure transfer.
FileOutputStream serializedFileOutput = new FileOutputStream("employee.ser");
ObjectOutputStream serializedObjOutput = new ObjectOutputStream(serializedFileOutput);
serializedObjOutput.writeObject(digitalSignedObj);
serializedObjOutput.close();
serializedFileOutput.close();We will also serialize the public key so that for this example we can send both of them to another machine to verify. (Note: In production implementations, both these objects shouldn’t be sent at the same time. The application at the other end should already have the public key)
serializedFileOutput = new FileOutputStream("publickey.ser");
serializedObjOutput = new ObjectOutputStream(serializedFileOutput);
serializedObjOutput.writeObject(publicKey);
serializedObjOutput.close();
serializedFileOutput.close();This will complete the creation of application one. When you run this application, it will create two new files in the same directory. employee.ser – which is the signed & serialized POJO (Salary details) & publickey.ser – public key to verify the POJO. Now using the appropriate protocol send these files to the other application (remote or local) and let’s start building the verification part.
2. Verification & De-Serializing the Java Object
As a start we have the files employee.ser & publickey.ser. Let’s start building up the class to verify & de-serialize these files. Let’s name this class DecryptEmployee. The following code should de-serialize the objects.
FileInputStream serializedPublicKeyIn = new FileInputStream("publicKey.ser");
ObjectInputStream serializedPublicKey = new ObjectInputStream(serializedPublicKeyIn);
PublicKey publicKey = (PublicKey) serializedPublicKey.readObject();
FileInputStream serializedEmployeeIn = new FileInputStream("employee.ser");
ObjectInputStream serializedEmployee = new ObjectInputStream(serializedEmployeeIn);
SignedObject digitalSignedObj = (SignedObject) serializedEmployee.readObject();Since the public key was not signed, publicKey variable will be readable. But the employee POJO was signed, so we are reading the object as a SignedObject. Let’s move forward and verify this.
Signature digitalSignature = Signature.getInstance(publicKey.getAlgorithm()); boolean decryptFlag = digitalSignedObj.verify(publicKey, digitalSignature);
The decryptFlag contains the status of the verification. If the public key is incorrect or if the object was tampered, then this will return false and we won’t be able to verify the object. If its true then everything looks good and we can successfully verify the POJO and print the values from HashMap.
if(decryptFlag) {
EmployeeValueObject employeeVO = (EmployeeValueObject) digitalSignedObj.getObject();
HashMap employeeSalary = (HashMap) employeeVO.getSalary();
Collection collHashMap = employeeSalary.values();
Iterator collectionIterator = collHashMap.iterator();
while (collectionIterator.hasNext()) {
System.out.println(collectionIterator.next());
}
} else {
System.out.println ("Decryption Failed. Please check the Keys.");
}If you run this application, we will get an output similar to below.
This can be used in any sensitive application to make sure that the objects which are transferred over the network are safe.
UPDATE: As mentioned by Salman A in the comments, the SignedObject signs the object, it doesn't encrypt it. So if you need encryption, you can use the Cipher class in Java.