JpsKeyStoreBeanImpl (Oracle Fusion Middleware Java API Reference for Oracle Platform Security Services)

Class

Use

Tree

Help

Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services
11g Release 1 (11.1.1)
E14651-04

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.security.jps.mas.mgmt.jmx.keystore
Class JpsKeyStoreBeanImpl

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

All Implemented Interfaces:: javax.management.MBeanRegistration, oracle.as.jmx.framework.lifecycle.Persistable, oracle.as.jmx.framework.lifecycle.SessionLifeCycle, oracle.as.jmx.framework.MessageLocalization, JpsKeyStoreMXBean

public class JpsKeyStoreBeanImpl

extends oracle.as.jmx.framework.util.ConfigMBeanSupport

implements JpsKeyStoreMXBean

Field Summary
`static java.lang.String`	`META_INF`

Fields inherited from interface oracle.security.jps.mas.mgmt.jmx.keystore.JpsKeyStoreMXBean
`RBN`

Constructor Summary
`JpsKeyStoreBeanImpl(KeyStoreService ks)` This constructor is specifically used for decoupling dependency on jps-config.xml, It allows creation of MBean directly with KeyStoreService instance

Method Summary
`void`	`changeKeyPassword(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String alias, char[] currentKeyPassword, char[] newKeyPassword)`
`void`	`changeKeyStorePassword(java.lang.String stripeName, java.lang.String keystoreName, char[] currentKeyStorePassword, char[] newKeyStorePassword)`
`void`	`createDemoCASignedCertificate(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String DN, PortableMap keyProps, java.lang.String alias, char[] keyPassword)`
`void`	`createKeyStore(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, boolean isPermissionProtected)`
`void`	`deleteKeyStore(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword)`
`void`	`deleteKeyStoreEntry(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String alias, char[] keyPassword)`
`java.lang.String`	`exportCertificateRequest(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String alias, char[] keyPassword)`
`java.lang.String`	`exportCertificates(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String alias, char[] keyPassword, java.lang.String keystoreEntryType)`
`byte[]`	`exportKeyStore(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String keyAliases, java.lang.String keyPasswords, java.lang.String keystoreType)`
`void`	`generateSecretKey(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, PortableMap keyProps, java.lang.String alias, char[] keyPassword)`
`java.security.cert.X509Certificate[]`	`getCertificates(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String alias, char[] keyPassword)`
`boolean`	`getFarmKeyStoreConfigured()`
`PortableMap`	`getKeyStoreProperties(java.lang.String stripeName, java.lang.String keystoreName)`
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` Returns the configured properties for this instance
`java.util.ArrayList<java.lang.String>`	`getSecretKeyProperties(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String alias, char[] keyPassword)`
`int[]`	`getSupportedKeySize(java.lang.String 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)`
`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)`
`boolean`	`isPasswordValid(char[] password)`
`java.lang.String[]`	`listAliases(java.lang.String stripeName, java.lang.String keystoreName, char[] keystorePassword, java.lang.String keystoreEntryType)`
`java.util.ArrayList<java.util.ArrayList<java.lang.String>>`	`listExpiringCertificates(int numberOfDaysFromExpiration, boolean autoRenew)`
`java.lang.String[]`	`listKeyStores(java.lang.String stripeName)`
`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()`
`static void`	`setCanonicalPath(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 <p/> 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

META_INF

public static final java.lang.String META_INF

See Also:: Constant Field Values

Constructor Detail

JpsKeyStoreBeanImpl

public JpsKeyStoreBeanImpl(KeyStoreService ks)

This constructor is specifically used for decoupling dependency on jps-config.xml, It allows creation of MBean directly with KeyStoreService instance

Parameters:: ks - The KeyStoreService to be associated with this MBean.
Throws:: java.lang.IllegalArgumentException - If ServiceInstance passed is a null

Method Detail

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Description copied from interface: JpsKeyStoreMXBean

Returns the configured properties for this instance

Specified by:: getProperties in interface JpsKeyStoreMXBean

Returns:: The properties

getFarmKeyStoreConfigured

public boolean getFarmKeyStoreConfigured()

Specified by:: getFarmKeyStoreConfigured in interface JpsKeyStoreMXBean

createKeyStore

public void createKeyStore(java.lang.String stripeName,
                           java.lang.String keystoreName,
                           char[] keystorePassword,
                           boolean isPermissionProtected)
                    throws oracle.as.jmx.framework.exceptions.ManagementException

Specified by:: createKeyStore in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

deleteKeyStore

public void deleteKeyStore(java.lang.String stripeName,
                           java.lang.String keystoreName,
                           char[] keystorePassword)
                    throws oracle.as.jmx.framework.exceptions.ManagementException

Specified by:: deleteKeyStore in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

listKeyStores

public java.lang.String[] listKeyStores(java.lang.String stripeName)
                                 throws oracle.as.jmx.framework.exceptions.ManagementException

Specified by:: listKeyStores in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

changeKeyStorePassword

public void changeKeyStorePassword(java.lang.String stripeName,
                                   java.lang.String keystoreName,
                                   char[] currentKeyStorePassword,
                                   char[] newKeyStorePassword)
                            throws oracle.as.jmx.framework.exceptions.ManagementException

Specified by:: changeKeyStorePassword in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

exportKeyStore

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

Specified by:: exportKeyStore in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

importKeyStore

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

Specified by:: importKeyStore in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

createDemoCASignedCertificate

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

Specified by:: createDemoCASignedCertificate in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

generateSecretKey

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

Specified by:: generateSecretKey in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

changeKeyPassword

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

Specified by:: changeKeyPassword in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

listAliases

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

Specified by:: listAliases in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

getCertificates

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

Specified by:: getCertificates in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

getSecretKeyProperties

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

Specified by:: getSecretKeyProperties in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

exportCertificateRequest

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

Specified by:: exportCertificateRequest in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

exportCertificates

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

Specified by:: exportCertificates in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

importCertificates

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

Specified by:: importCertificates in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

deleteKeyStoreEntry

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

Specified by:: deleteKeyStoreEntry in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

rollOverMasterKey

public void rollOverMasterKey()
                       throws oracle.as.jmx.framework.exceptions.ManagementException

Specified by:: rollOverMasterKey in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

listExpiringCertificates

public java.util.ArrayList<java.util.ArrayList<java.lang.String>> listExpiringCertificates(int numberOfDaysFromExpiration,
                                                                                           boolean autoRenew)
                                                                                    throws oracle.as.jmx.framework.exceptions.ManagementException

Specified by:: listExpiringCertificates in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

getKeyStoreProperties

public PortableMap getKeyStoreProperties(java.lang.String stripeName,
                                         java.lang.String keystoreName)
                                  throws oracle.as.jmx.framework.exceptions.ManagementException

Specified by:: getKeyStoreProperties in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

getSupportedKeySize

public int[] getSupportedKeySize(java.lang.String algorithm)
                          throws oracle.as.jmx.framework.exceptions.ManagementException

Specified by:: getSupportedKeySize in interface JpsKeyStoreMXBean

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

isPasswordValid

public boolean isPasswordValid(char[] password)

Specified by:: isPasswordValid in interface JpsKeyStoreMXBean

toString

public java.lang.String toString()

Overrides:: toString in class java.lang.Object

load

public void load()
          throws java.io.IOException

Specified by:: load in interface oracle.as.jmx.framework.lifecycle.Persistable
Specified by:: load in class oracle.as.jmx.framework.util.ConfigMBeanSupport

Throws:: java.io.IOException

persist

public void persist()
             throws oracle.as.jmx.framework.exceptions.ManagementException

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

setEventBroadcaster

@Inject
public void setEventBroadcaster(oracle.as.jmx.framework.services.EventBroadcaster eventBroadcaster)

Used by the dependency engine to provide access to the Event Service.The <p/> Inject annotation is used to mark a specific method as a dependency point that needs to be resolved by the framework

Overrides:: setEventBroadcaster in class oracle.as.jmx.framework.util.RuntimeMBeanSupport

setCanonicalPath

public static void setCanonicalPath(KeyStoreService ks,
                                    java.lang.String path)
                             throws oracle.as.jmx.framework.exceptions.ManagementException

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

refresh

public void refresh()
             throws oracle.as.jmx.framework.exceptions.ManagementException

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

preRegister

public javax.management.ObjectName preRegister(javax.management.MBeanServer server,
                                               javax.management.ObjectName name)
                                        throws java.lang.Exception

Pre MBean registration callback default implementation is no-op

Specified by:: preRegister in interface javax.management.MBeanRegistration
Overrides:: preRegister in class oracle.as.jmx.framework.util.ConfigMBeanSupport

Throws:: java.lang.Exception

preDeregister

public void preDeregister()
                   throws java.lang.Exception

Pre MBean unregistration callback

Specified by:: preDeregister in interface javax.management.MBeanRegistration
Overrides:: preDeregister in class oracle.as.jmx.framework.util.RuntimeMBeanSupport

Throws:: java.lang.Exception

Overview

Package