KeyStore isKeyEntry() method in Java with Examples

The isKeyEntry() method of java.security.KeyStore class is used to check if the particular specified key entry is present. It returns a boolean value stating the same.

Syntax:

public final boolean isKeyEntry(String alias) 
    throws KeyStoreException

Parameter: This method accepts the name of the alias as a parameter whose key entry to be checked.

Return Value: This method returns a boolean value stating the presence of the requested key entry.

Exception: This method throws KeyStoreException if you don’t initialize this keystore.

Note: All the programs in this article won’t run on online IDE as no ‘privatekey’ Keystore exists. You can check this code on Java compiler on your system. To check this code, create a Keystore ‘privatekey’ on your system and set your own Keystore password to access that Keystore.

Below are the examples to illustrate the isKeyEntry() method:

Example 1:

Java

// Java program to demonstrate isKeyEntry() method

import java.security.*;
import java.security.cert.*;
import java.util.*;
import java.io.*;

public class GFG {
    public static void main(String[] argv)
    {
        try {

            // creating the object of KeyStore
            // and getting instance
            // By using getInstance() method
            KeyStore sr = KeyStore.getInstance("JKS");

            // keystore password is required to access keystore
            char[] pass = ("123456").toCharArray();

            // creating and initializing object of InputStream
            InputStream is
                = new FileInputStream(
                    "f:/java/private key.store");

            // initializing keystore object
            sr.load(is, pass);

            // checking the presence of key entry
            // using isKeyEntry() method
            Boolean status
                = sr.isKeyEntry("ftpkey");

            // display the result
            if (status)
                System.out.println("\nkey entry is present");
            else
                System.out.println("\nkey entry is not present");
        }

        catch (NoSuchAlgorithmException e) {

            System.out.println("Exception thrown : " + e);
        }
        catch (NullPointerException e) {

            System.out.println("Exception thrown : " + e);
        }
        catch (KeyStoreException e) {

            System.out.println("Exception thrown : " + e);
        }
        catch (FileNotFoundException e) {

            System.out.println("Exception thrown : " + e);
        }
        catch (IOException e) {

            System.out.println("Exception thrown : " + e);
        }
        catch (CertificateException e) {

            System.out.println("Exception thrown : " + e);
        }
    }
}

Output:

Example 2: For KeyStoreException

Java

// Java program to demonstrate isKeyEntry() method

import java.security.*;
import java.security.cert.*;
import java.util.*;
import java.io.*;

public class GFG {
    public static void main(String[] argv)
    {
        try {

            // creating the object of KeyStore
            // and getting instance
            // By using getInstance() method
            KeyStore sr = KeyStore.getInstance("JKS");

            // keystore password is required to access keystore
            char[] pass = ("123456").toCharArray();

            // creating and initializing object of InputStream
            InputStream is
                = new FileInputStream(
                    "f:/java/private key.store");

            // initializing keystore object
            // sr.load(is, pass);

            // checking the presence of key entry
            // using isKeyEntry() method
            Boolean status
                = sr.isKeyEntry("ftpkey");

            // display the result
            if (status)
                System.out.println("key entry is present");
            else
                System.out.println("key entry is not present");
        }
        catch (NullPointerException e) {

            System.out.println("Exception thrown : " + e);
        }
        catch (KeyStoreException e) {

            System.out.println("Exception thrown : " + e);
        }
        catch (FileNotFoundException e) {

            System.out.println("Exception thrown : " + e);
        }
    }
}

Output:

Reference:https://docs.oracle.com/javase/9/docs/api/java/security/KeyStore.html#isKeyEntry-java.lang.String-