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 isCertificateEntry() method:

Example 1:

filter_none

edit
close

play_arrow

link
brightness_4
code

// 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 usng 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 isCertificateEntry() 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);
        }
    }
}

chevron_right


Output:

Example 2: For KeyStoreException

filter_none

edit
close

play_arrow

link
brightness_4
code

// 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 usng 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 isCertificateEntry() 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);
        }
    }
}

chevron_right


Output:

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

Attention reader! Don’t stop learning now. Get hold of all the important DSA concepts with the DSA Self Paced Course at a student-friendly price and become industry ready.




My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.



Improved By : shubham_singh