Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


weblogic.management.configuration
Interface SSLMBean

All Superinterfaces:
ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

public interface SSLMBean
extends ConfigurationMBean

This MBean represents the configuration of the SSL protocol.


Field Summary
static String BUILTIN_SSL_VALIDATION_AND_CERT_PATH_VALIDATORS
          Indicates that the built-in SSL certificate validation should be used to complete and validate the peer's certificate chain then the configured CertPathValidator security providers should be used to perform extra validation on the chain.
static String BUILTIN_SSL_VALIDATION_ONLY
          Indicates that only the built-in SSL certificate validation should be used to complete and validate the peer's certificate chain.
static String IDENTITY_AND_TRUST_LOCATIONS_FILES_OR_KEYSTORE_PROVIDERS
           
static String IDENTITY_AND_TRUST_LOCATIONS_KEYSTORES
           

 

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY

 

Method Summary
abstract  String[] getCiphersuites()
          Indicates the cipher suites being used on a particular WebLogic Server.
abstract  String getClientCertAlias()
          Determines the alias of the client SSL certificate to be used as identity for outbound SSL connections.
abstract  String getClientCertPrivateKeyPassPhrase()
          The passphrase used to retrieve the private key for the client SSL certificate specified in SSLMBean.getClientCertAlias() from the server configured keystore.
abstract  byte[] getClientCertPrivateKeyPassPhraseEncrypted()
          The encrypted passphrase used to retrieve the private key for the client SSL certificate specified in SSLMBean.getClientCertAlias() from the server configured keystore.
abstract  int getExportKeyLifespan()
          Indicates the number of times WebLogic Server can use an exportable key between a domestic server and an exportable client before generating a new key.
abstract  String getHostnameVerifier()
          The name of the class that implements the weblogic.security.SSL.HostnameVerifier interface.
abstract  String getIdentityAndTrustLocations()
          Indicates where SSL should find the server's identity (certificate and private key) as well as the server's trust (trusted CAs).
abstract  String getInboundCertificateValidation()
          Indicates the client certificate validation rules for inbound SSL.
abstract  int getListenPort()
          The TCP/IP port at which this server listens for SSL connection requests.
abstract  int getLoginTimeoutMillis()
          Specifies the number of milliseconds that WebLogic Server waits for an SSL connection before timing out.
abstract  String getMinimumTLSProtocolVersion()
          Get the minimum SSL/TLS protocol version currently configured.
abstract  String getOutboundCertificateValidation()
          Indicates the server certificate validation rules for outbound SSL.
abstract  String getOutboundPrivateKeyAlias()
          The string alias used to store and retrieve the outbound private key in the keystore.
abstract  String getOutboundPrivateKeyPassPhrase()
          The passphrase used to retrieve the outbound private key from the keystore.
abstract  String getServerCertificateChainFileName()
          Deprecated. 7.0.0.0 server certificates (and chains) should be stored in keystores.
abstract  String getServerCertificateFileName()
          Deprecated. 8.1.0.0 server certificates (and chains) should be stored in keystores.
abstract  String getServerKeyFileName()
          Deprecated. 8.1.0.0 private keys should be stored in keystores.
abstract  String getServerPrivateKeyAlias()
          The string alias used to store and retrieve the server's private key in the keystore.
abstract  String getServerPrivateKeyPassPhrase()
          The passphrase used to retrieve the server's private key from the keystore.
abstract  byte[] getServerPrivateKeyPassPhraseEncrypted()
          The encrypted passphrase used to retrieve the server's private key from the keystore.
abstract  String getTrustedCAFileName()
          Deprecated. 8.1.0.0 trusted CAs should be stored in keystores.
abstract  boolean isAcceptKSSDemoCertsEnabled()
           
abstract  boolean isAllowUnencryptedNullCipher()
          Test if the AllowUnEncryptedNullCipher is enabled
abstract  boolean isClientCertificateEnforced()
          Indicates whether or not clients must present digital certificates from a trusted certificate authority to WebLogic Server.
abstract  boolean isEnabled()
          Indicates whether the server can be reached through the default SSL listen port.
abstract  boolean isHostnameVerificationIgnored()
          Specifies whether to ignore the installed implementation of the weblogic.security.SSL.HostnameVerifier interface (when this server is acting as a client to another application server).
abstract  boolean isJSSEEnabled()
          Determines whether the SSL implementation in Weblogic Server is JSSE based.
abstract  boolean isSSLRejectionLoggingEnabled()
          Indicates whether warning messages are logged in the server log when SSL connections are rejected.
abstract  boolean isSSLv2HelloEnabled()
          Indicate whether SSLv2Hello is enabled
abstract  boolean isTwoWaySSLEnabled()
          The form of SSL that should be used.
abstract  boolean isUseClientCertForOutbound()
          Determines whether to use the configured client SSL certificate as identity for outbound SSL connections.
abstract  boolean isUseServerCerts()
          Sets whether the client should use the server certificates/key as the client identity when initiating an outbound connection over https.
abstract  void setAcceptKSSDemoCertsEnabled(boolean acceptKSSDemoCertsEnabled)
          Sets whether the default Hostname Verifier accept KSS Demo SSL Certificates
abstract  void setAllowUnencryptedNullCipher(boolean enable)
          When a SSL server and a SSL client try to negotiate a commonly supported Cipher, there is a chance that they may end up with nothing in common.
abstract  void setCertAuthenticator(String classname)
          Sets the value of the CertAuthenticator attribute.
abstract  void setCiphersuites(String[] ciphers)
          Sets the value of the Ciphersuites attribute.
abstract  void setClientCertAlias(String alias)
          Specifies the alias of the client SSL certificate to be used as identity for outbound SSL connections.
abstract  void setClientCertificateEnforced(boolean enforce)
          Sets the value of the ClientCertificateEnforced attribute.
abstract  void setClientCertPrivateKeyPassPhrase(String phrase)
          Specifies the passphrase used to retrieve the private key for the client SSL certificate specified in SSLMBean.getClientCertAlias() from the server configured keystore.
abstract  void setClientCertPrivateKeyPassPhraseEncrypted(byte[] phraseEncrypted)
          Specifies the encrypted passphrase used to retrieve the private key for the client SSL certificate specified in SSLMBean.getClientCertAlias() from the server configured keystore.
abstract  void setEnabled(boolean enable)
           
abstract  void setExportKeyLifespan(int lifespan)
          Sets the value of the ExportKeyLifespan attribute.
abstract  void setHostnameVerificationIgnored(boolean ignoreFlag)
          Sets the value of the HostnameVerificationIgnored attribute.
abstract  void setHostnameVerifier(String classname)
          Sets the value of the HostnameVerifier attribute.
abstract  void setIdentityAndTrustLocations(String locations)
          Sets the value of the IdentityAndTrustLocations attribute.
abstract  void setInboundCertificateValidation(String validationStyle)
          Sets the value of the InboundCertificateValidation attribute.
abstract  void setJSSEEnabled(boolean enabled)
          Specifies whether the SSL implementation in Weblogic Server is JSSE based.
abstract  void setListenPort(int port)
          Set the value of the ListenPort attribute.
abstract  void setLoginTimeoutMillis(int millis)
          Sets the value of the LoginTimeoutMillis attribute.
abstract  void setMinimumTLSProtocolVersion(String minimumTLSProtocolVersion)
          Set the minimum SSL/TLS protocol version
abstract  void setOutboundCertificateValidation(String validationStyle)
          Sets the value of the OutboundCertificateValidation attribute.
abstract  void setServerCertificateChainFileName(String fileName)
          Deprecated. 7.0.0.0 Server certificates (and chains) should be stored in keystores.
abstract  void setServerCertificateFileName(String fileName)
          Deprecated. 8.1.0.0 server certificates (and chains) should be stored in keystores.
abstract  void setServerKeyFileName(String fileName)
          Deprecated. 8.1.0.0 private keys should be stored in keystores.
abstract  void setServerPrivateKeyAlias(String alias)
          Sets the value of the ServerPrivateKeyAlias attribute.
abstract  void setServerPrivateKeyPassPhrase(String phrase)
          Sets the value of the ServerPrivateKeyPassPhrase attribute.
abstract  void setServerPrivateKeyPassPhraseEncrypted(byte[] phraseEncrypted)
          Sets the value of the ServerPrivateKeyPassPhrase attribute.
abstract  void setSSLRejectionLoggingEnabled(boolean enabled)
          Sets the value of the SSLRejectionLoggingEnabled attribute.
abstract  void setTrustedCAFileName(String fileName)
          Deprecated. 8.1.0.0 trusted CAs should be stored in keystores.
abstract  void setTwoWaySSLEnabled(boolean enabled)
          Sets the value of the TwoWaySSLEnabled attribute.
abstract  void setUseClientCertForOutbound(boolean enabled)
          Specifies whether to use the configured client SSL certificate as identity for outbound SSL connections.
abstract  void setUseServerCerts(boolean enabled)
          Indicates that an https client running within WebLogic server should use the server's certificate and key as the client identity.

 

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

 

Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

 

Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes

 

Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister

 

Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener

 

Methods inherited from interface weblogic.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

 

Field Detail

IDENTITY_AND_TRUST_LOCATIONS_KEYSTORES

static final String IDENTITY_AND_TRUST_LOCATIONS_KEYSTORES
See Also:
Constant Field Values

IDENTITY_AND_TRUST_LOCATIONS_FILES_OR_KEYSTORE_PROVIDERS

static final String IDENTITY_AND_TRUST_LOCATIONS_FILES_OR_KEYSTORE_PROVIDERS
See Also:
Constant Field Values

BUILTIN_SSL_VALIDATION_ONLY

static final String BUILTIN_SSL_VALIDATION_ONLY
Indicates that only the built-in SSL certificate validation should be used to complete and validate the peer's certificate chain.
See Also:
Constant Field Values

BUILTIN_SSL_VALIDATION_AND_CERT_PATH_VALIDATORS

static final String BUILTIN_SSL_VALIDATION_AND_CERT_PATH_VALIDATORS
Indicates that the built-in SSL certificate validation should be used to complete and validate the peer's certificate chain then the configured CertPathValidator security providers should be used to perform extra validation on the chain.
See Also:
Constant Field Values

Method Detail

isEnabled

boolean isEnabled()

Indicates whether the server can be reached through the default SSL listen port.

If the administration port is enabled for the WebLogic Server domain, then administrative traffic travels over the administration port and application traffic travels over the Listen Port and SSL Listen Port. If the administration port is disabled, then all traffic travels over the Listen Port and SSL Listen Port.

Returns:
The enabled value

setEnabled

void setEnabled(boolean enable)
                throws InvalidAttributeValueException
Parameters:
enable - The new enabled value
Throws:
InvalidAttributeValueException
See Also:
SSLMBean.isEnabled()

getCiphersuites

String[] getCiphersuites()

Indicates the cipher suites being used on a particular WebLogic Server.

The strongest negotiated cipher suite is chosen during the SSL handshake. The set of cipher suites used by default by JSEE depends on the specific JDK version with which WebLogic Server is configured.

For a list of possible values, see Cipher Suites.

Returns:
The ciphersuites value

setCiphersuites

void setCiphersuites(String[] ciphers)
                     throws InvalidAttributeValueException

Sets the value of the Ciphersuites attribute.

Parameters:
ciphers - The new ciphersuites value
Throws:
InvalidAttributeValueException - if the array is null or contains null elements.
See Also:
SSLMBean.getCiphersuites()

setCertAuthenticator

void setCertAuthenticator(String classname)
                          throws InvalidAttributeValueException

Sets the value of the CertAuthenticator attribute.

Parameters:
classname - The new certAuthenticator value
Throws:
InvalidAttributeValueException
See Also:
SSLMBean.getCertAuthenticator()

getHostnameVerifier

String getHostnameVerifier()

The name of the class that implements the weblogic.security.SSL.HostnameVerifier interface.

This class verifies whether the connection to the host with the hostname from URL should be allowed. The class is used to prevent man-in-the-middle attacks. The weblogic.security.SSL.HostnameVerifier has a verify() method that WebLogic Server calls on the client during the SSL handshake.

Returns:
The hostnameVerifier value

setHostnameVerifier

void setHostnameVerifier(String classname)
                         throws InvalidAttributeValueException

Sets the value of the HostnameVerifier attribute.

Parameters:
classname - The new hostnameVerifier value
Throws:
InvalidAttributeValueException
See Also:
SSLMBean.getHostnameVerifier()

isHostnameVerificationIgnored

boolean isHostnameVerificationIgnored()

Specifies whether to ignore the installed implementation of the weblogic.security.SSL.HostnameVerifier interface (when this server is acting as a client to another application server).

Returns:
The hostnameVerificationIgnored value

setHostnameVerificationIgnored

void setHostnameVerificationIgnored(boolean ignoreFlag)
                                    throws InvalidAttributeValueException

Sets the value of the HostnameVerificationIgnored attribute.

Parameters:
ignoreFlag - The new hostnameVerificationIgnored value
Throws:
InvalidAttributeValueException
See Also:
SSLMBean.isHostnameVerificationIgnored()

getTrustedCAFileName

String getTrustedCAFileName()
Deprecated. 8.1.0.0 trusted CAs should be stored in keystores.

The full directory location of the file that specifies the certificate authorities trusted by the server.

The pathname should either be absolute or relative to the directory from which the server is booted. This field provides backward compatibility for security configurations that store trusted certificate authorities in files.

The file specified in this attribute can contain a single digital certificate or multiple digital certificates. The file extension ( .der or .pem) tells WebLogic Server how to read the contents of the file.

Returns:
The trustedCAFileName value

setTrustedCAFileName

void setTrustedCAFileName(String fileName)
                          throws InvalidAttributeValueException
Deprecated. 8.1.0.0 trusted CAs should be stored in keystores.

Sets the value of the TrustedCAFileName attribute.

Parameters:
fileName - The new trustedCAFileName value
Throws:
InvalidAttributeValueException
See Also:
SSLMBean.getTrustedCAFileName()

isAcceptKSSDemoCertsEnabled

boolean isAcceptKSSDemoCertsEnabled()
Returns:
true if the default Hostname Verifier accepts KSS Demo SSL Certificates, false otherwise.

setAcceptKSSDemoCertsEnabled

void setAcceptKSSDemoCertsEnabled(boolean acceptKSSDemoCertsEnabled)

Sets whether the default Hostname Verifier accept KSS Demo SSL Certificates

Parameters:
acceptKSSDemoCertsEnabled - whether to accept KSS Demo SSL certificates

getExportKeyLifespan

int getExportKeyLifespan()

Indicates the number of times WebLogic Server can use an exportable key between a domestic server and an exportable client before generating a new key. The more secure you want WebLogic Server to be, the fewer times the key should be used before generating a new key.

Returns:
The exportKeyLifespan value

setExportKeyLifespan

void setExportKeyLifespan(int lifespan)
                          throws InvalidAttributeValueException

Sets the value of the ExportKeyLifespan attribute.

Parameters:
lifespan - The new exportKeyLifespan value
Throws:
InvalidAttributeValueException
See Also:
SSLMBean.getExportKeyLifespan()

isClientCertificateEnforced

boolean isClientCertificateEnforced()

Indicates whether or not clients must present digital certificates from a trusted certificate authority to WebLogic Server.

Returns:
The clientCertificateEnforced value

setClientCertificateEnforced

void setClientCertificateEnforced(boolean enforce)

Sets the value of the ClientCertificateEnforced attribute.

Parameters:
enforce - The new clientCertificateEnforced value
See Also:
SSLMBean.isClientCertificateEnforced()

getServerCertificateFileName

String getServerCertificateFileName()
Deprecated. 8.1.0.0 server certificates (and chains) should be stored in keystores.

The full directory location of the digital certificate file (.der or .pem) for the server.

The pathname should either be absolute or relative to the directory from which the server is booted. This field provides backward compatibility for security configurations that stored digital certificates in files.

The file extension ( .der or .pem) tells WebLogic Server how to read the contents of the file.

Returns:
The serverCertificateFileName value

setServerCertificateFileName

void setServerCertificateFileName(String fileName)
Deprecated. 8.1.0.0 server certificates (and chains) should be stored in keystores.

Sets the value of the ServerCertificateFileName attribute.

Parameters:
fileName - The new serverCertificateFileName value
See Also:
SSLMBean.getServerCertificateFileName()

getListenPort

int getListenPort()

The TCP/IP port at which this server listens for SSL connection requests.

Returns:
The listenPort value
See Also:
SSLMBean.isEnabled(), ServerTemplateMBean.getListenPort(), ServerTemplateMBean.getAdministrationPort(), NetworkAccessPointMBean.getListenPort()

setListenPort

void setListenPort(int port)

Set the value of the ListenPort attribute.

Parameters:
port - The new listenPort value
See Also:
SSLMBean.getListenPort()

getServerCertificateChainFileName

String getServerCertificateChainFileName()
Deprecated. 7.0.0.0 server certificates (and chains) should be stored in keystores.

The full directory location and name of the file containing an ordered list of certificate authorities trusted by WebLogic Server.

The .pem file extension indicates that method that should be used to read the file. Note that as of WebLogic Server version 7.0, the digital certificate for WebLogic Server should not be stored in a file.

Returns:
The serverCertificateChainFileName value

setServerCertificateChainFileName

void setServerCertificateChainFileName(String fileName)
Deprecated. 7.0.0.0 Server certificates (and chains) should be stored in keystores.

Sets the value of the ServerCertificateChainFileName attribute.

Parameters:
fileName - The new serverCertificateChainFileName value
See Also:
SSLMBean.getServerCertificateChainFileName()

getLoginTimeoutMillis

int getLoginTimeoutMillis()

Specifies the number of milliseconds that WebLogic Server waits for an SSL connection before timing out. SSL connections take longer to negotiate than regular connections.

If clients are connecting over the Internet, raise the default number to accommodate additional network latency.

Returns:
The loginTimeoutMillis value
See Also:
ServerTemplateMBean.getLoginTimeoutMillis(), NetworkChannelMBean.getLoginTimeoutMillisSSL()

setLoginTimeoutMillis

void setLoginTimeoutMillis(int millis)

Sets the value of the LoginTimeoutMillis attribute.

Parameters:
millis - The new loginTimeoutMillis value
See Also:
SSLMBean.getLoginTimeoutMillis()

getServerKeyFileName

String getServerKeyFileName()
Deprecated. 8.1.0.0 private keys should be stored in keystores.

The full directory location of the private key file (.der or .pem) for the server.

The pathname should either be absolute or relative to the directory from which the server is booted. This field provides backward compatibility for security configurations that store private keys in files. For a more secure deployment, Oracle recommends saving private keys in keystores.

The file extension (.der or .pem) indicates the method that should be used to read the file.

Returns:
The serverKeyFileName value

setServerKeyFileName

void setServerKeyFileName(String fileName)
Deprecated. 8.1.0.0 private keys should be stored in keystores.

Sets the value of the ServerKeyFileName attribute.

Parameters:
fileName - The new serverKeyFileName value
See Also:
SSLMBean.getServerKeyFileName()

isTwoWaySSLEnabled

boolean isTwoWaySSLEnabled()

The form of SSL that should be used.

By default, WebLogic Server is configured to use one-way SSL (implied by the Client Certs Not Requested value). Selecting Client Certs Requested But Not Enforced enables two-way SSL. With this option, the server requests a certificate from the client, but the connection continues if the client does not present a certificate. Selecting Client Certs Requested And Enforced also enables two-way SSL and requires a client to present a certificate. However, if a certificate is not presented, the SSL connection is terminated.

Returns:
The twoWaySSLEnabled value

setTwoWaySSLEnabled

void setTwoWaySSLEnabled(boolean enabled)

Sets the value of the TwoWaySSLEnabled attribute.

Parameters:
enabled - The new twoWaySSLEnabled value
See Also:
SSLMBean.isTwoWaySSLEnabled()

getServerPrivateKeyAlias

String getServerPrivateKeyAlias()

The string alias used to store and retrieve the server's private key in the keystore. This private key is associated with the server's digital certificate.

Returns:
The serverPrivateKeyAlias value

setServerPrivateKeyAlias

void setServerPrivateKeyAlias(String alias)

Sets the value of the ServerPrivateKeyAlias attribute.

Parameters:
alias - The new serverPrivateKeyAlias value
See Also:
SSLMBean.getServerPrivateKeyAlias()

getServerPrivateKeyPassPhrase

String getServerPrivateKeyPassPhrase()

The passphrase used to retrieve the server's private key from the keystore. This passphrase is assigned to the private key when it is generated.

Returns:
The serverPrivateKeyPassPhrase value

setServerPrivateKeyPassPhrase

void setServerPrivateKeyPassPhrase(String phrase)

Sets the value of the ServerPrivateKeyPassPhrase attribute.

As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:

  1. Retrieves the value of the ServerPrivateKeyPassPhraseEncrypted attribute.
  2. Decrypts the value and returns the unencrypted passphrase as a String.

When you set the value of this attribute, WebLogic Server does the following:

  1. Encrypts the value.
  2. Sets the value of the ServerPrivateKeyPassPhraseEncrypted attribute to the encrypted value.

Using this attribute (ServerPrivateKeyPassPhrase) is a potential security risk because the String object (which contains the unencrypted passphrase) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.

Instead of using this attribute, use getServerPrivateKeyPassPhraseEncrypted.

Parameters:
phrase - The new serverPrivateKeyPassPhrase value
See Also:
SSLMBean.getServerPrivateKeyPassPhrase(), SSLMBean.setServerPrivateKeyPassPhraseEncrypted(byte[])

getServerPrivateKeyPassPhraseEncrypted

byte[] getServerPrivateKeyPassPhraseEncrypted()

The encrypted passphrase used to retrieve the server's private key from the keystore. This passphrase is assigned to the private key when it is generated.

To set this attribute, use weblogic.management.EncryptionHelper.encrypt() to encrypt the value. Then set this attribute to the output of the encrypt() method.

To compare a password that a user enters with the encrypted value of this attribute, go to the same WebLogic Server instance that you used to set and encrypt this attribute and use weblogic.management.EncryptionHelper.encrypt() to encrypt the user-supplied password. Then compare the encrypted values.

Returns:
The encrypted serverPrivateKeyPassPhrase value

setServerPrivateKeyPassPhraseEncrypted

void setServerPrivateKeyPassPhraseEncrypted(byte[] phraseEncrypted)

Sets the value of the ServerPrivateKeyPassPhrase attribute.

Parameters:
phraseEncrypted - The new encrypted serverPrivateKeyPassPhrase value
See Also:
SSLMBean.getServerPrivateKeyPassPhraseEncrypted()

isSSLRejectionLoggingEnabled

boolean isSSLRejectionLoggingEnabled()

Indicates whether warning messages are logged in the server log when SSL connections are rejected.

Returns:
The sSLRejectionLoggingEnabled value
Since:
8.1.0.0

setSSLRejectionLoggingEnabled

void setSSLRejectionLoggingEnabled(boolean enabled)

Sets the value of the SSLRejectionLoggingEnabled attribute.

Parameters:
enabled - The new sSLRejectionLoggingEnabled value
See Also:
SSLMBean.isSSLRejectionLoggingEnabled()

getIdentityAndTrustLocations

String getIdentityAndTrustLocations()

Indicates where SSL should find the server's identity (certificate and private key) as well as the server's trust (trusted CAs).

Domains created in WebLogic Server version 8.1 or later, default to KEYSTORES. Domains created before WebLogic Server version 8.1, default to FILES_OR_KEYSTORE_PROVIDERS.

Returns:
The identityAndTrustLocations value

setIdentityAndTrustLocations

void setIdentityAndTrustLocations(String locations)

Sets the value of the IdentityAndTrustLocations attribute.

Parameters:
locations - The new identityAndTrustLocations value
See Also:
SSLMBean.getIdentityAndTrustLocations()

getInboundCertificateValidation

String getInboundCertificateValidation()

Indicates the client certificate validation rules for inbound SSL.

This attribute only applies to ports and network channels using 2-way SSL.

Returns:
a String containing the validation style.
Since:
9.0.0.0

setInboundCertificateValidation

void setInboundCertificateValidation(String validationStyle)

Sets the value of the InboundCertificateValidation attribute.

Parameters:
validationStyle - the new validation style
Since:
9.0.0.0
See Also:
SSLMBean.getInboundCertificateValidation()

getOutboundCertificateValidation

String getOutboundCertificateValidation()

Indicates the server certificate validation rules for outbound SSL.

This attribute always applies to outbound SSL that is part of WebLogic Server (that is, an Administration Server talking to the Node Manager). It does not apply to application code in the server that is using outbound SSL unless the application code uses a weblogic.security.SSL.ServerTrustManager that is configured to use outbound SSL validation.

Returns:
a String containing the validation style.
Since:
9.0.0.0

setOutboundCertificateValidation

void setOutboundCertificateValidation(String validationStyle)

Sets the value of the OutboundCertificateValidation attribute.

Parameters:
validationStyle - the new validation style
Since:
9.0.0.0
See Also:
SSLMBean.getOutboundCertificateValidation()

setAllowUnencryptedNullCipher

void setAllowUnencryptedNullCipher(boolean enable)

When a SSL server and a SSL client try to negotiate a commonly supported Cipher, there is a chance that they may end up with nothing in common. A NullCipher is a cipher providing no encryption for the SSL message between the client and server, and it may temporarily be used in the development environment if the SSL server and client share no common cipher for some reason. This is not a standard SSL feature, some SSL provider supports this feature

The AllowUnEncryptedNullCipher flag is used to control whether the NullCipher feature is enabled or not, if true, the SSL message may be unencrypted when SSL server and client shares no common cipher.

This AllowUnEncryptedNullCipher flag is only effective to SSL providers which support the NullCipher feature.

Warning: this NullCipher feature should NOT be enabled for a production environment, it may leads to unencrypted SSL message

By default, the AllowUnEncryptedNullCipher is false

Parameters:
enable - true to allow NullCipher feature
Since:
10.3.0.0

isAllowUnencryptedNullCipher

boolean isAllowUnencryptedNullCipher()

Test if the AllowUnEncryptedNullCipher is enabled

see setAllowUnencryptedNullCipher(boolean enable) for the NullCipher feature.

Returns:
true if NullCipher feature is allowed. If the SSL provider does not support NullCipher feature, it always return false.
Since:
10.3.0.0

isUseServerCerts

boolean isUseServerCerts()
Sets whether the client should use the server certificates/key as the client identity when initiating an outbound connection over https.

setUseServerCerts

void setUseServerCerts(boolean enabled)
Indicates that an https client running within WebLogic server should use the server's certificate and key as the client identity.
Parameters:
enabled - Uses the server identity for the client

setJSSEEnabled

void setJSSEEnabled(boolean enabled)
Specifies whether the SSL implementation in Weblogic Server is JSSE based.
Parameters:
enabled - true to select the JSSE-based SSL implementation

isJSSEEnabled

boolean isJSSEEnabled()
Determines whether the SSL implementation in Weblogic Server is JSSE based.
Returns:
true if the selected Weblogic Server SSL implementation is JSSE based, otherwise false.

setUseClientCertForOutbound

void setUseClientCertForOutbound(boolean enabled)
Specifies whether to use the configured client SSL certificate as identity for outbound SSL connections.

Note that to use a client SSL certificate, one must be specified in SSLMBean.setClientCertAlias(java.lang.String).

Parameters:
enabled - true to enable use of the configured client SSL certificate for outbound connections, otherwise false.
See Also:
SSLMBean.isUseClientCertForOutbound(), SSLMBean.setClientCertAlias(java.lang.String)

isUseClientCertForOutbound

boolean isUseClientCertForOutbound()
Determines whether to use the configured client SSL certificate as identity for outbound SSL connections.

Note that to use a client SSL certificate, one must be specified in SSLMBean.setClientCertAlias(java.lang.String).

Returns:
true if use of the configured client SSL certificate for outbound SSL connections is enabled.
See Also:
SSLMBean.setUseClientCertForOutbound(boolean), SSLMBean.getClientCertAlias()

setClientCertAlias

void setClientCertAlias(String alias)
Specifies the alias of the client SSL certificate to be used as identity for outbound SSL connections. The certificate is assumed to be stored in the server configured keystore.

Note that to use the client SSL certificate, SSLMBean.setUseClientCertForOutbound(boolean) must be enabled.

Parameters:
alias - Alias of the client SSL certificate in the server configured keystore
See Also:
SSLMBean.getClientCertAlias(), SSLMBean.setUseClientCertForOutbound(boolean)

getClientCertAlias

String getClientCertAlias()
Determines the alias of the client SSL certificate to be used as identity for outbound SSL connections. The certificate is assumed to be stored in the server configured keystore.

Note that to use the client SSL certificate, SSLMBean.setUseClientCertForOutbound(boolean) must be enabled.

Returns:
Alias of the client SSL certificate in the server configured keystore for use in outbound SSL connections, null if none.
See Also:
SSLMBean.setClientCertAlias(java.lang.String), SSLMBean.isUseClientCertForOutbound()

getClientCertPrivateKeyPassPhrase

String getClientCertPrivateKeyPassPhrase()

The passphrase used to retrieve the private key for the client SSL certificate specified in SSLMBean.getClientCertAlias() from the server configured keystore. This passphrase is assigned to the private key when the private key is generated.

Note that this attribute is usually used when outbound SSL connections specify a client SSL certificate identity.

Note that when you get the value of this attribute, WebLogic Server does the following:

  1. Retrieves the value of the ClientCertPrivateKeyPassPhraseEncrypted attribute.
  2. Decrypts the value and returns the unencrypted passphrase.
Returns:
The client SSL certificate private key pass phrase.
See Also:
SSLMBean.setClientCertPrivateKeyPassPhrase(java.lang.String), SSLMBean.isUseClientCertForOutbound(), SSLMBean.getClientCertAlias()

setClientCertPrivateKeyPassPhrase

void setClientCertPrivateKeyPassPhrase(String phrase)
Specifies the passphrase used to retrieve the private key for the client SSL certificate specified in SSLMBean.getClientCertAlias() from the server configured keystore. This passphrase is assigned to the private key when the private key is generated.

Note that this attribute is usually used when outbound SSL connections specify a client SSL certificate identity.

Note that when you set the value of this attribute, WebLogic Server does the following:

  1. Encrypts the value.
  2. Sets the value of the ClientCertPrivateKeyPassPhraseEncrypted attribute to the encrypted value.
Parameters:
phrase - The client SSL certificate private key pass phrase.
See Also:
SSLMBean.getClientCertPrivateKeyPassPhrase(), SSLMBean.setUseClientCertForOutbound(boolean), SSLMBean.setClientCertAlias(java.lang.String)

getClientCertPrivateKeyPassPhraseEncrypted

byte[] getClientCertPrivateKeyPassPhraseEncrypted()

The encrypted passphrase used to retrieve the private key for the client SSL certificate specified in SSLMBean.getClientCertAlias() from the server configured keystore. This passphrase is assigned to the private key when the private key is generated.

To compare a password that a user enters with the encrypted value of this attribute, go to the same WebLogic Server instance that you used to set and encrypt this attribute, and use weblogic.management.EncryptionHelper.encrypt() to encrypt the user-supplied password. Then compare the encrypted values.

Note that this attribute is usually used when outbound SSL connections specify a client SSL certificate identity.

Returns:
The encrypted ClientCertPrivateKeyPassPhrase value
See Also:
SSLMBean.setClientCertPrivateKeyPassPhraseEncrypted(byte[]), SSLMBean.isUseClientCertForOutbound(), SSLMBean.getClientCertAlias(), SSLMBean.getClientCertPrivateKeyPassPhrase()

setClientCertPrivateKeyPassPhraseEncrypted

void setClientCertPrivateKeyPassPhraseEncrypted(byte[] phraseEncrypted)
Specifies the encrypted passphrase used to retrieve the private key for the client SSL certificate specified in SSLMBean.getClientCertAlias() from the server configured keystore. This passphrase is assigned to the private key when the private key is generated.

Note that to set this attribute, use weblogic.management.EncryptionHelper.encrypt() to encrypt the value. Then set this attribute to the output of the encrypt() method.

Note that this attribute is usually used when outbound SSL connections specify a client SSL certificate identity.

Parameters:
phraseEncrypted - The encrypted ClientCertPrivateKeyPassPhrase value
See Also:
SSLMBean.getClientCertPrivateKeyPassPhraseEncrypted(), SSLMBean.setUseClientCertForOutbound(boolean), SSLMBean.setClientCertAlias(java.lang.String), SSLMBean.setClientCertPrivateKeyPassPhrase(java.lang.String)

getOutboundPrivateKeyAlias

String getOutboundPrivateKeyAlias()

The string alias used to store and retrieve the outbound private key in the keystore. This private key is associated with either a server or a client digital certificate. This attribute value is derived from other settings and cannot be physically set.

The returned value is determined as follows:

Returns:
The OutboundPrivateKeyAlias value
See Also:
SSLMBean.isUseClientCertForOutbound(), SSLMBean.getClientCertAlias(), SSLMBean.getServerPrivateKeyAlias()

getOutboundPrivateKeyPassPhrase

String getOutboundPrivateKeyPassPhrase()

The passphrase used to retrieve the outbound private key from the keystore. This passphrase is assigned to the private key when it is generated. This attribute value is derived from other settings and cannot be physically set.

The returned value is determined as follows:

Returns:
The OutboundPrivateKeyPassPhrase value
See Also:
SSLMBean.isUseClientCertForOutbound(), SSLMBean.getClientCertPrivateKeyPassPhrase(), SSLMBean.getServerPrivateKeyPassPhrase()

getMinimumTLSProtocolVersion

String getMinimumTLSProtocolVersion()
Get the minimum SSL/TLS protocol version currently configured.
Returns:
the minimum TLS protocol version. The return value should always be passed to the internal APIs to correctly get back a set of enabled protocol versions.
See Also:
SSLMBean.setMinimumTLSProtocolVersion(String)

setMinimumTLSProtocolVersion

void setMinimumTLSProtocolVersion(String minimumTLSProtocolVersion)
                                  throws InvalidAttributeValueException
Set the minimum SSL/TLS protocol version
Parameters:
minimumTLSProtocolVersion - the new minimum SSL/TLS protocol version
Throws:
InvalidAttributeValueException

isSSLv2HelloEnabled

boolean isSSLv2HelloEnabled()
Indicate whether SSLv2Hello is enabled
Returns:
whether SSLv2Hello is enabled(only applicable if the configured JSSE provider supports SSLv2Hello).

Skip navigation links

Copyright 1996, 2015, 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
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09