|
Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services 11g Release 1 (11.1.1) E14651-05 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
oracle.as.jmx.framework.util.MessageLocalizationSupport
oracle.as.jmx.framework.util.RuntimeMBeanSupport
oracle.as.jmx.framework.util.BasicConfigMBeanSupport
oracle.as.jmx.framework.util.ConfigMBeanSupport
oracle.security.jps.mas.mgmt.jmx.keystore.JpsKeyStoreBeanImpl
public class JpsKeyStoreBeanImpl
| Field Summary | |
|---|---|
static java.lang.String |
META_INF |
| Fields inherited from interface oracle.security.jps.mas.mgmt.jmx.keystore.JpsKeyStoreMXBean |
|---|
RBN |
| Constructor Summary | |
|---|---|
JpsKeyStoreBeanImpl(oracle.security.jps.service.keystore.KeyStoreService ks)This constructor is specifically used for decoupling dependency on jps-config.xml, It allows creation of MBean directly with KeyStoreService instance |
|
JpsKeyStoreBeanImpl(java.util.Properties props)Create an instance of KeyStoreService MBean which is associated to a KeyStore service configured in 'context' specified by properties |
|
| 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>. |
void |
load() |
void |
persist() |
void |
preDeregister()Pre MBean unregistration callback |
javax.management.ObjectName |
preRegister(javax.management.MBeanServer server, javax.management.ObjectName name)Pre MBean registration callback default implementation is no-op |
void |
refresh() |
void |
rollOverMasterKey()Performs a roll-over of the encryption key as a routine exercise, or in case of key compromise |
static void |
setCanonicalPath(oracle.security.jps.service.keystore.KeyStoreService ks, java.lang.String path) |
void |
setEventBroadcaster(oracle.as.jmx.framework.services.EventBroadcaster eventBroadcaster)Used by the dependency engine to provide access to the Event Service.The Inject annotation is used to mark a specific method as a dependency point that needs to be resolved by the framework |
java.lang.String |
toString() |
| Methods inherited from class oracle.as.jmx.framework.util.ConfigMBeanSupport |
|---|
checkPoint, save, setConfigURL, setDataSource, validate |
| Methods inherited from class oracle.as.jmx.framework.util.BasicConfigMBeanSupport |
|---|
joinSession, postCommitSession, preCommitSession, rollbackSession |
| Methods inherited from class oracle.as.jmx.framework.util.RuntimeMBeanSupport |
|---|
postDeregister, postRegister |
| Methods inherited from class oracle.as.jmx.framework.util.MessageLocalizationSupport |
|---|
getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, setJMXSupport |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String META_INF
| Constructor Detail |
|---|
public JpsKeyStoreBeanImpl(oracle.security.jps.service.keystore.KeyStoreService ks)
ks - The KeyStoreService to be associated with this MBean.java.lang.IllegalArgumentException - If ServiceInstance passed is a null
public JpsKeyStoreBeanImpl(java.util.Properties props)
throws oracle.as.jmx.framework.exceptions.ManagementException,
oracle.security.jps.JpsException
props - properties which capture context information JpsJmxConstants "JPS_JMX_BEAN_SECURITY_CONTEXT" defines key for for the 'context'ManagementException, - JpsExceptionoracle.as.jmx.framework.exceptions.ManagementExceptionoracle.security.jps.JpsException| Method Detail |
|---|
public java.util.Map<java.lang.String,java.lang.String> getProperties()
JpsKeyStoreMXBeangetProperties in interface JpsKeyStoreMXBeanpublic boolean getFarmKeyStoreConfigured()
JpsKeyStoreMXBeangetFarmKeyStoreConfigured in interface JpsKeyStoreMXBean
public void createKeyStore(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword,
boolean isPermissionProtected)
throws oracle.as.jmx.framework.exceptions.ManagementException
JpsKeyStoreMXBeancreateKeyStore in interface JpsKeyStoreMXBeanstripeName - 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
public void deleteKeyStore(java.lang.String stripeName,
java.lang.String keystoreName,
char[] keystorePassword)
throws oracle.as.jmx.framework.exceptions.ManagementException
JpsKeyStoreMXBeandeleteKeyStore in interface JpsKeyStoreMXBeanstripeName - 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
public java.lang.String[] listKeyStores(java.lang.String stripeName)
throws oracle.as.jmx.framework.exceptions.ManagementException
JpsKeyStoreMXBeanlistKeyStores in interface JpsKeyStoreMXBeanstripeName - application stripe whose keystores need to be listed. Can be a wild card "*"oracle.as.jmx.framework.exceptions.ManagementException
public void changeKeyStorePassword(java.lang.String stripeName,
java.lang.String keystoreName,
char[] currentKeyStorePassword,
char[] newKeyStorePassword)
throws oracle.as.jmx.framework.exceptions.ManagementException
JpsKeyStoreMXBeanchangeKeyStorePassword in interface JpsKeyStoreMXBeanstripeName - application stripe of the keystore whose password is changedkeystoreName - name of the keystorecurrentKeyStorePassword - current keystore passwordnewKeyStorePassword - new keystore passwordoracle.as.jmx.framework.exceptions.ManagementException
public 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
JpsKeyStoreMXBeanexportKeyStore in interface JpsKeyStoreMXBeanstripeName - 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
public 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
JpsKeyStoreMXBeanimportKeyStore in interface JpsKeyStoreMXBeanstripeName - 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
public 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
JpsKeyStoreMXBeancreateDemoCASignedCertificate in interface JpsKeyStoreMXBeanstripeName - 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
public 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
JpsKeyStoreMXBeangenerateSecretKey in interface JpsKeyStoreMXBeanstripeName - 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
public 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
JpsKeyStoreMXBeanchangeKeyPassword in interface JpsKeyStoreMXBeanstripeName - 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
public 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
JpsKeyStoreMXBeanlistAliases in interface JpsKeyStoreMXBeanstripeName - 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
public 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
JpsKeyStoreMXBeangetCertificates in interface JpsKeyStoreMXBeanstripeName - 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
public 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
JpsKeyStoreMXBeangetSecretKeyProperties in interface JpsKeyStoreMXBeanstripeName - 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
public 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
JpsKeyStoreMXBeanexportCertificateRequest in interface JpsKeyStoreMXBeanstripeName - 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
public 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
JpsKeyStoreMXBeanexportCertificates in interface JpsKeyStoreMXBeanstripeName - 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
public 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
JpsKeyStoreMXBeanimportCertificates in interface JpsKeyStoreMXBeanstripeName - 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
public 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
JpsKeyStoreMXBeandeleteKeyStoreEntry in interface JpsKeyStoreMXBeanstripeName - 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
public void rollOverMasterKey()
throws oracle.as.jmx.framework.exceptions.ManagementException
JpsKeyStoreMXBeanrollOverMasterKey in interface JpsKeyStoreMXBeanoracle.as.jmx.framework.exceptions.ManagementException
public java.util.ArrayList<java.util.ArrayList<java.lang.String>> listExpiringCertificates(int numberOfDaysFromExpiration,
boolean autoRenew)
throws oracle.as.jmx.framework.exceptions.ManagementException
JpsKeyStoreMXBeanlistExpiringCertificates in interface JpsKeyStoreMXBeannumberOfDaysFromExpiration - 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
public PortableMap getKeyStoreProperties(java.lang.String stripeName,
java.lang.String keystoreName)
throws oracle.as.jmx.framework.exceptions.ManagementException
JpsKeyStoreMXBeangetKeyStoreProperties in interface JpsKeyStoreMXBeanstripeName - application stripekeystoreName - keystore nameoracle.as.jmx.framework.exceptions.ManagementException
public int[] getSupportedKeySize(java.lang.String algorithm)
throws oracle.as.jmx.framework.exceptions.ManagementException
JpsKeyStoreMXBeangetSupportedKeySize in interface JpsKeyStoreMXBeanalgorithm - key algorithmoracle.as.jmx.framework.exceptions.ManagementExceptionpublic boolean isPasswordValid(char[] password)
JpsKeyStoreMXBeanisPasswordValid in interface JpsKeyStoreMXBeanpassword - password to be checked - null or empty strings are not allowedpublic java.lang.String toString()
toString in class java.lang.Object
public void load()
throws java.io.IOException
load in interface oracle.as.jmx.framework.lifecycle.Persistableload in class oracle.as.jmx.framework.util.ConfigMBeanSupportjava.io.IOException
public void persist()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Inject
public void setEventBroadcaster(oracle.as.jmx.framework.services.EventBroadcaster eventBroadcaster)
Inject annotation is used to mark a specific method as a dependency point that needs to be resolved by the framework
setEventBroadcaster in class oracle.as.jmx.framework.util.RuntimeMBeanSupport
public static void setCanonicalPath(oracle.security.jps.service.keystore.KeyStoreService ks,
java.lang.String path)
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
public void refresh()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
public javax.management.ObjectName preRegister(javax.management.MBeanServer server,
javax.management.ObjectName name)
throws java.lang.Exception
preRegister in interface javax.management.MBeanRegistrationpreRegister in class oracle.as.jmx.framework.util.ConfigMBeanSupportjava.lang.Exception
public void preDeregister()
throws java.lang.Exception
preDeregister in interface javax.management.MBeanRegistrationpreDeregister in class oracle.as.jmx.framework.util.RuntimeMBeanSupportjava.lang.Exception
|
Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services 11g Release 1 (11.1.1) E14651-05 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||