Oracle Fusion Middleware
Oracle WebLogic Server 10.3.1 MBean API Reference
11g Release 1 (10.3.1)

Part Number E13945-02

weblogic.management.security.pk
Interface KeyStoreMBean

All Superinterfaces:
ProviderMBean
All Known Subinterfaces:
DefaultKeyStoreMBean

Deprecated. 8.1.0.0

public interface KeyStoreMBean
extends ProviderMBean

The SSPI MBean that all Keystore providers must extend. It was deprecated in WLS 8.1.

Deprecation of MBeanHome and Type-Safe Interfaces

In addition to being used as a base class that provides functionality to security provider MBeans, JMX applications can use this class directly as a type-safe interface. When used as a type-safe interface, a JMX application imports this class and accesses it through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, JMX applications that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime.


Method Summary
 String getPrivateKeyStoreLocation()
          Deprecated. Returns the location of the keystore used to store identities - that is, certificate and private key pairs.
 String getPrivateKeyStorePassPhrase()
          Deprecated. Returns the passphrase used to access the keystore specified by the PrivateKeyStoreLocation attribute.
 byte[] getPrivateKeyStorePassPhraseEncrypted()
          Deprecated. Returns the passphrase used to access the keystore specified by the PrivateKeyStoreLocation attribute.
 String getRootCAKeyStoreLocation()
          Deprecated. Returns the location of the keystore used to store trusted certificate authority certificates.
 String getRootCAKeyStorePassPhrase()
          Deprecated. Returns the passphrase used to access the keystore specified by the RootCAKeyStoreLocation attribute.
 byte[] getRootCAKeyStorePassPhraseEncrypted()
          Deprecated. Returns the passphrase used to access the keystore specified by the RootCAKeyStoreLocation attribute.
 String getType()
          Deprecated. Returns the type of the Keystore implementation that this provider supports, as defined by the JavaSoft Cryptography Architecture specification.
 void setPrivateKeyStoreLocation(String location)
          Deprecated. Sets the location of the keystore used to store identities - that is, certificate and private key pairs.
 void setPrivateKeyStorePassPhrase(String passphrase)
          Deprecated. Sets the passphrase used to access the keystore specified by the PrivateKeyStoreLocation attribute.
 void setPrivateKeyStorePassPhraseEncrypted(byte[] bytes)
          Deprecated. Sets the passphrase used to access the keystore specified by the PrivateKeyStoreLocation attribute.
 void setRootCAKeyStoreLocation(String location)
          Deprecated. Sets the location of the keystore used to store trusted certificate authority certificates.
 void setRootCAKeyStorePassPhrase(String passphrase)
          Deprecated. Sets the passphrase used to access the keystore specified by the RootCAKeyStoreLocation attribute.
 void setRootCAKeyStorePassPhraseEncrypted(byte[] bytes)
          Deprecated. Sets the passphrase used to access the keystore specified by the RootCAKeyStoreLocation attribute.
 
Methods inherited from interface weblogic.management.security.ProviderMBean
getDescription, getName, getRealm, getVersion
 

Method Detail

getPrivateKeyStorePassPhrase

String getPrivateKeyStorePassPhrase()
Deprecated. 
Returns the passphrase used to access the keystore specified by the PrivateKeyStoreLocation attribute. If the passphase is null, no passphrase will be used to access the keystore.

See Also:
KeyStoreMBean.getPrivateKeyStorePassPhraseEncrypted()
Default Value:
null

setPrivateKeyStorePassPhrase

void setPrivateKeyStorePassPhrase(String passphrase)
                                  throws InvalidAttributeValueException
Deprecated. 
Sets the passphrase used to access the keystore specified by the PrivateKeyStoreLocation attribute. Set the passphrase to null if no passphrase is needed to access the keystore.

Parameters:
passphrase - - the new keystore passphrase
Throws:
InvalidAttributeValueException
See Also:
KeyStoreMBean.getPrivateKeyStorePassPhrase(), KeyStoreMBean.setPrivateKeyStorePassPhraseEncrypted(byte[])

getPrivateKeyStorePassPhraseEncrypted

byte[] getPrivateKeyStorePassPhraseEncrypted()
Deprecated. 
Returns the passphrase used to access the keystore specified by the PrivateKeyStoreLocation attribute. If the passphase is null, no passphrase will be used to access the keystore.

Returns:
The passphrase as an encrypted byte array.
Default Value:
null

setPrivateKeyStorePassPhraseEncrypted

void setPrivateKeyStorePassPhraseEncrypted(byte[] bytes)
                                           throws InvalidAttributeValueException
Deprecated. 
Sets the passphrase used to access the keystore specified by the PrivateKeyStoreLocation attribute. Set the passphrase to null if no passphrase is needed to access the keystore.

Parameters:
bytes - The new passphrase as a byte array.
Throws:
InvalidAttributeValueException
See Also:
KeyStoreMBean.getPrivateKeyStorePassPhraseEncrypted()

getRootCAKeyStorePassPhrase

String getRootCAKeyStorePassPhrase()
Deprecated. 
Returns the passphrase used to access the keystore specified by the RootCAKeyStoreLocation attribute. If the passphase is null, no passphrase will be used to access the keystore.

See Also:
KeyStoreMBean.getRootCAKeyStorePassPhraseEncrypted()

setRootCAKeyStorePassPhrase

void setRootCAKeyStorePassPhrase(String passphrase)
                                 throws InvalidAttributeValueException
Deprecated. 
Sets the passphrase used to access the keystore specified by the RootCAKeyStoreLocation attribute. Set the passphrase to null if no passphrase is needed to access the keystore.

Parameters:
passphrase - - the new keystore passphrase
Throws:
InvalidAttributeValueException
See Also:
KeyStoreMBean.getRootCAKeyStorePassPhrase(), KeyStoreMBean.setRootCAKeyStorePassPhraseEncrypted(byte[])

getRootCAKeyStorePassPhraseEncrypted

byte[] getRootCAKeyStorePassPhraseEncrypted()
Deprecated. 
Returns the passphrase used to access the keystore specified by the RootCAKeyStoreLocation attribute. If the passphase is null, no passphrase will be used to access the keystore.

Returns:
The passphrase as an encrypted byte array.
Default Value:
null

setRootCAKeyStorePassPhraseEncrypted

void setRootCAKeyStorePassPhraseEncrypted(byte[] bytes)
                                          throws InvalidAttributeValueException
Deprecated. 
Sets the passphrase used to access the keystore specified by the RootCAKeyStoreLocation attribute. Set the passphrase to null if no passphrase is needed to access the keystore.

Parameters:
bytes - The new passphrase as a byte array.
Throws:
InvalidAttributeValueException
See Also:
KeyStoreMBean.getRootCAKeyStorePassPhraseEncrypted()

getPrivateKeyStoreLocation

String getPrivateKeyStoreLocation()
Deprecated. 
Returns the location of the keystore used to store identities - that is, certificate and private key pairs.

The configured Keystore provider implementation determines the requirements for this attribute. For more information about legal values, refer to the documentation supplied by the Keystore security vendor.

Default Value:
null

setPrivateKeyStoreLocation

void setPrivateKeyStoreLocation(String location)
                                throws InvalidAttributeValueException
Deprecated. 
Sets the location of the keystore used to store identities - that is, certificate and private key pairs.

Parameters:
location - - the new keystore location
Throws:
InvalidAttributeValueException
See Also:
KeyStoreMBean.getPrivateKeyStoreLocation()

getRootCAKeyStoreLocation

String getRootCAKeyStoreLocation()
Deprecated. 
Returns the location of the keystore used to store trusted certificate authority certificates.

The configured Keystore provider implementation determines the requirements for this attribute. For more information about legal values, refer to the documentation supplied by the Keystore security vendor.

Default Value:
null

setRootCAKeyStoreLocation

void setRootCAKeyStoreLocation(String location)
                               throws InvalidAttributeValueException
Deprecated. 
Sets the location of the keystore used to store trusted certificate authority certificates. For more information about legal values, refer to the documentation supplied by the Keystore security vendor.

Parameters:
location - - the new keystore pathname
Throws:
InvalidAttributeValueException
See Also:
KeyStoreMBean.getRootCAKeyStoreLocation()

getType

String getType()
Deprecated. 
Returns the type of the Keystore implementation that this provider supports, as defined by the JavaSoft Cryptography Architecture specification.

Default Value:
"jks"

Documentation is available at
http://download.oracle.com/docs/cd/E12839_01/web.1111/wls.htm
Copyright 1996, 2009, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Oracle WebLogic Server 10.3.1 MBean API Reference
11g Release 1 (10.3.1)

Part Number E13945-02