Skip navigation links

Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server
11g Release 2 (11.1.2)

E27155-01 ESAPI


oracle.security.jps.service.keystore
Interface KeyStoreService

All Superinterfaces:
JpsPersistable, ServiceInstance

public interface KeyStoreService
extends ServiceInstance

A KeyStoreService is a PKI based keystore service interface


Nested Class Summary
static class KeyStoreService.KEYSTORE_ATTRIBUTE
           

 

Nested classes/interfaces inherited from interface oracle.security.jps.service.JpsPersistable
JpsPersistable.Mode

 

Method Summary
 void createKeyStore(java.lang.String stripeName, java.lang.String keystoreName, java.security.KeyStore.ProtectionParameter protParam, KeyStoreProperties props)
          This method creates a key store using the given keystore name, within the stripe name.
 void deleteKeyStore(java.lang.String stripeName, java.lang.String keystoreName, java.security.KeyStore.ProtectionParameter protParam)
          This method deletes an existing keystore.
 java.security.KeyStore getDomainTrustStore()
          This method gets a handle to the domain level trust store stored in FKS.
 java.security.KeyStore getKeyStore(java.lang.String stripeName, java.lang.String keystoreName, java.security.KeyStore.ProtectionParameter protParam)
          This method gets a handle to a given keystore stored in FKS.
 java.lang.Object getKeyStoreAttribute(java.lang.String stripeName, java.lang.String keystoreName, KeyStoreService.KEYSTORE_ATTRIBUTE attr)
          This method returns the specific attribute of a given key store within a stripe
 java.util.Map<java.lang.String,java.lang.String> getProperties()
          Returns the configured properties for this instance
 java.lang.String[] listKeyStores(java.lang.String stripeName)
          This method lists all the keystores within the given stripe.

 

Methods inherited from interface oracle.security.jps.service.ServiceInstance
accept, getName, getServiceProvider

 

Methods inherited from interface oracle.security.jps.service.JpsPersistable
persist, refresh

 

Method Detail

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()
Returns the configured properties for this instance
Returns:
The properties

createKeyStore

void createKeyStore(java.lang.String stripeName,
                    java.lang.String keystoreName,
                    java.security.KeyStore.ProtectionParameter protParam,
                    KeyStoreProperties props)
                    throws KeyStoreServiceException,
                           java.security.AccessControlException
This method creates a key store using the given keystore name, within the stripe name. The stripe name typically represents the name of the component or application using the key store. The keystore name must be unique within a given stripe. The keystore could be protected by a password specified by protParam. Additional keystore properties can be specified using props, like if the keystore is created within an HSM (not supported in this version), or if its protected by permissions only. Note that setting the permissions only flag to false doesn't mean permission check is disabled. It only means that password protection is also used.
Parameters:
stripeName - Name of the stripe within which keystore is created
keystoreName - name of the keystore. Must be unique within this stripe
protParam - Protection parameter for this keystore. Usually a password.
props - Additional keystore properties. eg. if permission protected is set to false, the keystore is also protected by password. The HSM property is ignored.
Throws:
KeyStoreServiceException
java.security.AccessControlException

deleteKeyStore

void deleteKeyStore(java.lang.String stripeName,
                    java.lang.String keystoreName,
                    java.security.KeyStore.ProtectionParameter protParam)
                    throws KeyStoreServiceException,
                           java.security.AccessControlException
This method deletes an existing keystore.
Parameters:
stripeName - Name of the stripe within which keystore is deleted
keystoreName - Name of the keystore to be deleted
protParam - Protection parameter for this keystore to be used for verification. Usually a password. This parameter is ignored if the keystore is only permission protected
Throws:
KeyStoreServiceException
java.security.AccessControlException

listKeyStores

java.lang.String[] listKeyStores(java.lang.String stripeName)
                                 throws KeyStoreServiceException,
                                        java.security.AccessControlException
This method lists all the keystores within the given stripe. If a wild card value "*" is specified for stripe name, then all the keystores within all the stripes are listed.
Parameters:
stripeName - name of the stripe whose keystores need to be listed. Use "*" as wildcard to specify all stripes
Returns:
names of the keystores within this stripe. If a definite stripe name is given, only the keystore names are returned. If a wildcard value is given, then the keystore names are returned as <stripe>/<keystore>
Throws:
KeyStoreServiceException
java.security.AccessControlException

getDomainTrustStore

java.security.KeyStore getDomainTrustStore()
                                           throws KeyStoreServiceException,
                                                  java.security.AccessControlException
This method gets a handle to the domain level trust store stored in FKS. The returned type is java.security.KeyStore so standard JDK APIs can be used by callers to access the keys and certificates from this key store.
Returns:
the domain level trust store
Throws:
KeyStoreServiceException
java.security.AccessControlException

getKeyStore

java.security.KeyStore getKeyStore(java.lang.String stripeName,
                                   java.lang.String keystoreName,
                                   java.security.KeyStore.ProtectionParameter protParam)
                                   throws KeyStoreServiceException,
                                          java.security.AccessControlException
This method gets a handle to a given keystore stored in FKS. The stripe name and keystore name indicate the keystore to be loaded and the protection parameter (password) is used for acess check.
Parameters:
stripeName - Name of the stripe
keystoreName - Name of the keystore to be loaded
protParam - Protection parameter for this keystore (usually a password). This parameter is ignored for keystore that is only permission protected
Returns:
the keystore object
Throws:
KeyStoreServiceException
java.security.AccessControlException

getKeyStoreAttribute

java.lang.Object getKeyStoreAttribute(java.lang.String stripeName,
                                      java.lang.String keystoreName,
                                      KeyStoreService.KEYSTORE_ATTRIBUTE attr)
                                      throws KeyStoreServiceException,
                                             java.security.AccessControlException
This method returns the specific attribute of a given key store within a stripe
Parameters:
stripeName - Name of the stripe
keystoreName - Name of the keystore
attr - Keystore attribute to be returned
Returns:
Value of the key store attribute. For modification time, an object of type java.util.Date is returned. For hsm protected or permission protected, a Boolean is returned.
Throws:
KeyStoreServiceException
java.security.AccessControlException

Skip navigation links

Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server
11g Release 2 (11.1.2)

E27155-01 ESAPI


Copyright © 2011,2012, Oracle and/or its affiliates. All rights reserved.