- java.lang.Object
-
- java.security.KeyStore.Builder
-
- Enclosing class:
- KeyStore
public abstract static class KeyStore.Builder extends Object
A description of a to-be-instantiated KeyStore object.An instance of this class encapsulates the information needed to instantiate and initialize a KeyStore object. That process is triggered when the getKeyStore() method is called.
This makes it possible to decouple configuration from KeyStore object creation and e.g. delay a password prompt until it is needed.
- Since:
- 1.5
- See Also:
KeyStore
,KeyStoreBuilderParameters
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
KeyStore.Builder()
Construct a new Builder.
-
Method Summary
Methods Modifier and Type Method and Description abstract KeyStore
getKeyStore()
Returns the KeyStore described by this object.abstract KeyStore.ProtectionParameter
getProtectionParameter(String alias)
Returns the ProtectionParameters that should be used to obtain theEntry
with the given alias.static KeyStore.Builder
newInstance(KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter)
Returns a new Builder that encapsulates the given KeyStore.static KeyStore.Builder
newInstance(String type, Provider provider, File file, KeyStore.ProtectionParameter protection)
Returns a new Builder object.static KeyStore.Builder
newInstance(String type, Provider provider, KeyStore.ProtectionParameter protection)
Returns a new Builder object.
-
-
-
Method Detail
-
getKeyStore
public abstract KeyStore getKeyStore() throws KeyStoreException
Returns the KeyStore described by this object.- Throws:
KeyStoreException
- if an error occured during the operation, for example if the KeyStore could not be instantiated or loaded
-
getProtectionParameter
public abstract KeyStore.ProtectionParameter getProtectionParameter(String alias) throws KeyStoreException
Returns the ProtectionParameters that should be used to obtain theEntry
with the given alias. ThegetKeyStore
method must be invoked before this method may be called.- Parameters:
alias
- the alias of the KeyStore entry- Returns:
- the ProtectionParameters that should be used to obtain
the
Entry
with the given alias. - Throws:
NullPointerException
- if alias is nullKeyStoreException
- if an error occured during the operationIllegalStateException
- if the getKeyStore method has not been invoked prior to calling this method
-
newInstance
public static KeyStore.Builder newInstance(KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter)
Returns a new Builder that encapsulates the given KeyStore. The getKeyStore() method of the returned object will returnkeyStore
, the getProtectionParameter() method will returnprotectionParameters
.This is useful if an existing KeyStore object needs to be used with Builder-based APIs.
- Parameters:
keyStore
- the KeyStore to be encapsulatedprotectionParameter
- the ProtectionParameter used to protect the KeyStore entries- Returns:
- a new Builder object
- Throws:
NullPointerException
- if keyStore or protectionParameters is nullIllegalArgumentException
- if the keyStore has not been initialized
-
newInstance
public static KeyStore.Builder newInstance(String type, Provider provider, File file, KeyStore.ProtectionParameter protection)
Returns a new Builder object.The first call to the
getKeyStore()
method on the returned builder will create a KeyStore of typetype
and call itsload()
method. TheinputStream
argument is constructed fromfile
. Ifprotection
is aPasswordProtection
, the password is obtained by calling thegetPassword
method. Otherwise, ifprotection
is aCallbackHandlerProtection
, the password is obtained by invoking the CallbackHandler.Subsequent calls to
getKeyStore()
return the same object as the initial call. If the initial call to failed with a KeyStoreException, subsequent calls also throw a KeyStoreException.The KeyStore is instantiated from
provider
if non-null. Otherwise, all installed providers are searched.Calls to
getProtectionParameter()
will return aPasswordProtection
object encapsulating the password that was used to invoke theload
method.Note that the
getKeyStore()
method is executed within theAccessControlContext
of the code invoking this method.- Parameters:
type
- the type of KeyStore to be constructedprovider
- the provider from which the KeyStore is to be instantiated (or null)file
- the File that contains the KeyStore dataprotection
- the ProtectionParameter securing the KeyStore data- Returns:
- a new Builder object
- Throws:
NullPointerException
- if type, file or protection is nullIllegalArgumentException
- if protection is not an instance of either PasswordProtection or CallbackHandlerProtection; or if file does not exist or does not refer to a normal file
-
newInstance
public static KeyStore.Builder newInstance(String type, Provider provider, KeyStore.ProtectionParameter protection)
Returns a new Builder object.Each call to the
getKeyStore()
method on the returned builder will return a new KeyStore object of typetype
. Itsload()
method is invoked using aLoadStoreParameter
that encapsulatesprotection
.The KeyStore is instantiated from
provider
if non-null. Otherwise, all installed providers are searched.Calls to
getProtectionParameter()
will returnprotection
.Note that the
getKeyStore()
method is executed within theAccessControlContext
of the code invoking this method.- Parameters:
type
- the type of KeyStore to be constructedprovider
- the provider from which the KeyStore is to be instantiated (or null)protection
- the ProtectionParameter securing the Keystore- Returns:
- a new Builder object
- Throws:
NullPointerException
- if type or protection is null
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-java/security/keystore.builder.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.