|
Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services 11g Release 1 (11.1.1) E14651-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.description",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@ImmutableInfo(value="true")
@Visibility(value=Advanced)
@SystemMBean
@MBeanRequiredGlobalSecurityRole(value=Admin)
public interface JpsKeyStoreMXBean
This interface defines the operations for KeyStore management complying to JMX standards
Field Summary | |
---|---|
static java.lang.String |
RBN |
Method Summary | |
---|---|
void |
changeKeyPassword(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String alias, char[] currentKeyPassword, char[] newKeyPassword) Changes the key password for a secret key or key pair entry |
void |
changeKeyStorePassword(java.lang.String stripeName, java.lang.String keystoreName, char[] currentKeyStorePassword, char[] newKeyStorePassword) Changes the password of a password protected keystore. |
void |
createDemoCASignedCertificate(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String DN, PortableMap keyProps, java.lang.String alias, char[] keyPassword) Generates a key pair and wraps it in a demo CA signed certificate |
void |
createKeyStore(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, boolean isPermissionProtected) This method creates a new key store. |
void |
deleteKeyStore(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword) This method deletes an existing key store |
void |
deleteKeyStoreEntry(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String alias, char[] keyPassword) Deletes a given entry from the key store |
java.lang.String |
exportCertificateRequest(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String alias, char[] keyPassword) Generates a PKCS#10 certificate request and exports it from a keystore |
java.lang.String |
exportCertificates(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String alias, char[] keyPassword, java.lang.String keystoreEntryType) Exports the certificate, certificate chain or trusted certificate in base64 format |
byte[] |
exportKeyStore(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String keyAliases, java.lang.String keyPasswords, java.lang.String keystoreType) Exports the keystore into a byte array |
void |
generateSecretKey(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, PortableMap keyProps, java.lang.String alias, char[] keyPassword) Generates a secret key |
java.security.cert.X509Certificate[] |
getCertificates(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String alias, char[] keyPassword) Returns the certificate, certificate chain or trusted certificate for a given alias |
boolean |
getFarmKeyStoreConfigured() This method returns true if KeyStoreService is configured. |
PortableMap |
getKeyStoreProperties(java.lang.String stripeName, java.lang.String keystoreName) helper method for EM to list a given keystore properties without specifying its password |
java.util.Map<java.lang.String,java.lang.String> |
getProperties() This method returns the configured properties for this service instance |
java.util.ArrayList<java.lang.String> |
getSecretKeyProperties(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String alias, char[] keyPassword) Returns the properties of the secret key, like key algorithm |
int[] |
getSupportedKeySize(java.lang.String algorithm) Helper method for EM to list the supported key sizes for a given key algorithm |
void |
importCertificates(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String alias, char[] keyPassword, java.lang.String keystoreEntryType, java.lang.String keystoreEntry) Imports a certificate, certificate chain or trusted certificate into a keystore |
void |
importKeyStore(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String keyAliases, java.lang.String keyPasswords, java.lang.String keystoreType, byte[] keystore, boolean isPermissionProtected) imports a keystore into keystore service |
boolean |
isPasswordValid(char[] password) Helper method for EM to check if a given password is valid |
java.lang.String[] |
listAliases(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String keystoreEntryType) Lists the aliases present in a given key store |
java.util.ArrayList<java.util.ArrayList<java.lang.String>> |
listExpiringCertificates(int numberOfDaysFromExpiration, boolean autoRenew) Lists the certificates that are going to expire in the next "n" days. |
java.lang.String[] |
listKeyStores(java.lang.String stripeName) This method lists the keystores present within a given application stripe in the format <keystore>. |
Field Detail |
---|
static final java.lang.String RBN
Method Detail |
---|
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.getProperties",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.util.Map<java.lang.String,java.lang.String> getProperties()
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.getFKSConfigured",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
boolean getFarmKeyStoreConfigured()
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.createKeyStore",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void createKeyStore(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword,
boolean isPermissionProtected)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripe where keystore is createdkeystoreName
- name of the keystore createdkeystorePassword
- password of the key store. This is used only if the parameter isPermissionProtected is set to false.isPermissionProtected
- true if the keystore is permission protected only. false, if the keystore is protected by both permission and passwordoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.deleteKeyStore",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void deleteKeyStore(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripe where keystore is deletedkeystoreName
- name of the keystore being deletedkeystorePassword
- password of the keystore being deleted. This parameter is ignored if the keystore is permission protected only.oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.listKeyStores",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String[] listKeyStores(java.lang.String stripeName)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripe whose keystores need to be listed. Can be a wild card "*"oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.changeKeyStorePassword",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void changeKeyStorePassword(java.lang.String stripeName,
java.lang.String keystoreName,
char[] currentKeyStorePassword,
char[] newKeyStorePassword)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripe of the keystore whose password is changedkeystoreName
- name of the keystorecurrentKeyStorePassword
- current keystore passwordnewKeyStorePassword
- new keystore passwordoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.exportKeyStore",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
byte[] exportKeyStore(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword,
java.lang.String keyAliases,
java.lang.String keyPasswords,
java.lang.String keystoreType)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripe of the keystore being exportedkeystoreName
- name of the keystorekeystorePassword
- keystore passwordkeyAliases
- comma separated list of aliases to be exportedkeyPasswords
- comma separated passwords corresponding to the aliaseskeystoreType
- format in which keystore needs to be exported. The supported types are JKS and JCEKSoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.importKeyStore",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void importKeyStore(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword,
java.lang.String keyAliases,
java.lang.String keyPasswords,
java.lang.String keystoreType,
byte[] keystore,
boolean isPermissionProtected)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripe of the keystore to which import should happenkeystoreName
- name of the keystorekeystorePassword
- password of the keystore being imported. Also represents the password of the imported keystore in KSSkeyAliases
- comma separated list of aliases from the keystore being importedkeyPasswords
- comma separated list of passwords corresponding to key aliaseskeystoreType
- type of keystore being imported, supported values are JKS and JCEKSkeystore
- byte array representing the keystore being importedisPermissionProtected
- if the keystore being imported to, is permission protected onlyoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.createDemoCASignedCertificate",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void createDemoCASignedCertificate(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword,
java.lang.String DN,
PortableMap keyProps,
java.lang.String alias,
char[] keyPassword)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripe where key pair is generatedkeystoreName
- name of the keystorekeystorePassword
- password of the keystore. if it is permission protected only, the parameter is ignoredDN
- distinguished name of the certificatekeyProps
- properties representing information about the key pair, like key size and algorithmalias
- alias of the key pairkeyPassword
- password of the key pair. this parameter is unused for keystore that is permission protected onlyoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.generateSecretKey",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void generateSecretKey(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword,
PortableMap keyProps,
java.lang.String alias,
char[] keyPassword)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripe where secret key is to be generatedkeystoreName
- name of the keystorekeystorePassword
- keystore password, if the keystore is also password protected. The parameter is ignored if it is only permission protectedkeyProps
- properties representing information about the secret key, like key size and algorithmalias
- alias of the secret keykeyPassword
- password of the keyoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.changeKeyPassword",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void changeKeyPassword(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword,
java.lang.String alias,
char[] currentKeyPassword,
char[] newKeyPassword)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripekeystoreName
- keystore namekeystorePassword
- password of the keystore, ignored for only permission protected keystoresalias
- alias of the key entrycurrentKeyPassword
- current key passwordnewKeyPassword
- new key passwordoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.listAliases",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String[] listAliases(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword,
java.lang.String keystoreEntryType)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripekeystoreName
- keystore namekeystorePassword
- password of the keystorekeystoreEntryType
- type of entry to be listed. Valid values are "Certificate", "TrustedCertificate", "SecretKey" or "*" for all typesoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.getCertificates",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.security.cert.X509Certificate[] getCertificates(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword,
java.lang.String alias,
char[] keyPassword)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripekeystoreName
- name of the keystorekeystorePassword
- password of the key storealias
- alias whose certificate needs to be exportedkeyPassword
- this parameter is not usedoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.getSecretKey",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.util.ArrayList<java.lang.String> getSecretKeyProperties(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword,
java.lang.String alias,
char[] keyPassword)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripekeystoreName
- name of the keystorekeystorePassword
- keystore password, ignored for keystores that are only permission protectedalias
- alias of the secret key entrykeyPassword
- password of the scret keyoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.exportCertificateRequest",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String exportCertificateRequest(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword,
java.lang.String alias,
char[] keyPassword)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripekeystoreName
- name of the keystorekeystorePassword
- password of the key storealias
- alias of the key pair entry which should be used for certificate request generationkeyPassword
- password of the key pairoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.exportCertificates",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String exportCertificates(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword,
java.lang.String alias,
char[] keyPassword,
java.lang.String keystoreEntryType)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripekeystoreName
- name of the keystorekeystorePassword
- keystore passwordalias
- alias of the certificate entry to be exportedkeyPassword
- this parameter is not usedkeystoreEntryType
- type of entry to be exported. valid values are "Certificate", "TrustedCertificate" or "PKCS7"oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.importCertificates",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void importCertificates(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword,
java.lang.String alias,
char[] keyPassword,
java.lang.String keystoreEntryType,
java.lang.String keystoreEntry)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripekeystoreName
- name of the keystorekeystorePassword
- keystore passwordalias
- alias where the entry should be importedkeyPassword
- password of the key pair if the entry being exported is a certificate or certificate chainkeystoreEntryType
- type of entry - valid values are "Certificate", "TrustedCertificate" or "PKCS7".keystoreEntry
- Base64 encoded entry to be importedoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.deleteKeyStoreEntry",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void deleteKeyStoreEntry(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword,
java.lang.String alias,
char[] keyPassword)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripekeystoreName
- name of the keystorekeystorePassword
- keystore password; ignored for keystores that are only permission protectedalias
- alias of the entry to be deletedkeyPassword
- password of the secret key or key pair to be deleted.oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.listExpiringCertificates",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
java.util.ArrayList<java.util.ArrayList<java.lang.String>> listExpiringCertificates(int numberOfDaysFromExpiration,
boolean autoRenew)
throws oracle.as.jmx.framework.exceptions.ManagementException
numberOfDaysFromExpiration
- Number of days within which certificates are going to expireautoRenew
- true if expiring certificates should be auto-renewed. false, if they should only be listed.oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.getKeyStoreProperties",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableMap getKeyStoreProperties(java.lang.String stripeName,
java.lang.String keystoreName)
throws oracle.as.jmx.framework.exceptions.ManagementException
stripeName
- application stripekeystoreName
- keystore nameoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.getSupportedKeySize",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
int[] getSupportedKeySize(java.lang.String algorithm)
throws oracle.as.jmx.framework.exceptions.ManagementException
algorithm
- key algorithmoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsKeyStoreMXBean.isPasswordValid",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
boolean isPasswordValid(char[] password)
password
- password to be checked - null or empty strings are not allowed
|
Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services 11g Release 1 (11.1.1) E14651-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |