ConfigurationMBean, ConfigurationPropertiesMBean, DescriptorBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, WebLogicMBeanpublic interface CertificateManagementMBean extends ConfigurationPropertiesMBean
Provides configuration for the WebLogic Certificate Management Service.
DEFAULT_EMPTY_BYTE_ARRAY| Modifier and Type | Method | Description |
|---|---|---|
CertificateIssuerPluginMBean |
createCertificateIssuerPlugin(java.lang.String name) |
Creates a new CertificateIssuerPlugin instance in the domain
|
void |
destroyCertificateIssuerPlugin(CertificateIssuerPluginMBean certificateIssuerPluginMBean) |
Deletes a CertificateIssuerPluginMBean
|
java.lang.String |
getCertificateAuthorityKeyProfile() |
Returns the configured Certificate Authority key profile.
|
java.lang.String |
getCertificateAuthoritySignatureAlgorithm() |
Returns the configured signature algorithm for Certificate Authorities.
|
int |
getCertificateAuthorityValidityPeriod() |
Returns the validity period (certificate lifetime) that
the Domain Certificates Issuer should set when generating a new Certificate Authority
certificate.
|
int |
getCertificateCheckInterval() |
Returns the certificate check interval -- how often the
Certificate Management Service should check for/refresh
expiring certificates (in days).
|
java.lang.String |
getCertificateCheckTime() |
Returns the optional local server time at which the Certificate Management
Service begins each certificate check.
|
int |
getCertificateCheckTimeMaximumOffset() |
Returns the maximum random offset, in seconds, added to a configured
certificate check time.
|
CertificateIssuerPluginMBean[] |
getCertificateIssuerPlugins() |
Returns the CertificateIssuerPlugins for this Domain.
|
java.lang.String |
getCertificateKeyProfile() |
Returns the configured leaf certificate key profile.
|
int |
getCertificateRefreshWindow() |
Returns the certificate refresh window.
|
int |
getCertificateValidityPeriod() |
Returns the validity period (certificate lifetime) that
the Domain Certificates Issuer should set when generating a new certificate.
|
int |
getExpiredCertificateAuthorityRetentionDays() |
Returns the number of days an expired Certificate Authority remains
trusted in the Admin Server's
domain-trust or
provisioned-trust source store before automatic cleanup removes
it. |
long |
getKeystoreFileLockTimeout() |
Returns the maximum number of milliseconds WebLogic Server waits to
acquire a cross-process Certificate Management keystore file lock.
|
java.lang.String |
getSubjectAlternativeNames() |
A space- or comma-separated list of words representing the Subject Alternative Names
that the Domain Certificates Issuer should include when generating a server certificate.
|
java.lang.String |
getSubjectCommonName() |
The fully qualified endpoint identity the Domain Certificates Issuer
should prefer for a server certificate's Subject common name and first
Subject Alternative Name: either the local hostname
(
hostname) or the server's listen address
(listen_address). |
java.lang.String |
getSubjectNamePolicy() |
Controls which host names and literal IP addresses the Domain
Certificates Issuer may place in a certificate subject.
|
boolean |
isEnabled() |
Returns true or false to indicate whether the Certificate Management Service
is enabled or not.
|
boolean |
isIncludeRootCertificateInChain() |
Whether the Domain Certificates Issuer should include the self-signed root CA
in the certificate chain for a generated certificate.
|
boolean |
isJavaStandardTrustEnabled() |
Whether or not the domain should trust the Java Standard Trust certificates,
in addition to the Domain Certificate Authority certificate(s) and any
Provisioned Trust certificates.
|
boolean |
isKeystoreFileLockingEnabled() |
Returns whether WebLogic Server uses cross-process file locks when
accessing shared Certificate Management keystores.
|
boolean |
isKeystoreFileWatchingEnabled() |
Returns whether WebLogic Server watches Certificate Management
keystore files for changes made by another process.
|
boolean |
isProvisionedCertificatesIssuerEnabled() |
Returns true or false to indicate whether the Provisioned Certificates Issuer
is enabled or not.
|
boolean |
isSinglePurposeCertificatesEnabled() |
Returns the single purpose certificates enabled value: whether the Domain Certificates Issuer
should generate separate, single-purpose certificates for different purposes
(server authentication, client authentication, signing and encryption), or generate
one certificate that supports all those purposes.
|
CertificateIssuerPluginMBean |
lookupCertificateIssuerPlugin(java.lang.String name) |
Looks up a CertificateIssuerPluginMBean by name.
|
void |
setCertificateAuthorityKeyProfile(java.lang.String certificateAuthorityKeyProfile) |
Sets the Certificate Authority key profile.
|
void |
setCertificateAuthoritySignatureAlgorithm(java.lang.String certificateAuthoritySignatureAlgorithm) |
Sets the signature algorithm for Certificate Authorities.
|
void |
setCertificateAuthorityValidityPeriod(int certificateAuthorityValidityPeriod) |
Sets the certificate authority validity period (in days).
|
void |
setCertificateCheckInterval(int certificateCheckInterval) |
Sets the certificate check interval (in days).
|
void |
setCertificateCheckTime(java.lang.String certificateCheckTime) |
Sets the optional local server time at which the Certificate Management
Service begins each certificate check.
|
void |
setCertificateCheckTimeMaximumOffset(int certificateCheckTimeMaximumOffset) |
Sets the maximum random offset, in seconds, added to a configured
certificate check time.
|
void |
setCertificateKeyProfile(java.lang.String certificateKeyProfile) |
Sets the leaf certificate key profile.
|
void |
setCertificateRefreshWindow(int certificateRefreshWindow) |
Sets the certificate refresh window (in days).
|
void |
setCertificateValidityPeriod(int certificateValidityPeriod) |
Sets the certificate validity period (in days).
|
void |
setEnabled(boolean isEnabled) |
Enables or disables the Certificate Management Service.
|
void |
setExpiredCertificateAuthorityRetentionDays(int expiredCertificateAuthorityRetentionDays) |
Sets the number of days an expired Certificate Authority remains
trusted in the Admin Server's
domain-trust or
provisioned-trust source store before automatic cleanup removes
it. |
void |
setIncludeRootCertificateInChain(boolean isIncludeRootCertificateInChain) |
Enables or disables inclusion of the self-signed root CA for Domain Certificates.
|
void |
setJavaStandardTrustEnabled(boolean isJavaStandardTrustEnabled) |
Whether or not the domain should trust the Java Standard Trust certificates
in addition to the Domain Certificate Authority certificate(s) and any
Provisioned Trust certificates.
|
void |
setKeystoreFileLockingEnabled(boolean enabled) |
Sets whether WebLogic Server uses cross-process file locks when
accessing shared Certificate Management keystores.
|
void |
setKeystoreFileLockTimeout(long timeout) |
Sets the maximum number of milliseconds WebLogic Server waits to
acquire a cross-process Certificate Management keystore file lock.
|
void |
setKeystoreFileWatchingEnabled(boolean enabled) |
Sets whether WebLogic Server watches Certificate Management keystore
files for changes made by another process.
|
void |
setProvisionedCertificatesIssuerEnabled(boolean isProvisionedCertificatesIssuerEnabled) |
Enables or disables the Provisioned Certificates Issuer.
|
void |
setSinglePurposeCertificatesEnabled(boolean isSinglePurposeCertificatesEnabled) |
Enables or disables single purpose certificates.
|
void |
setSubjectAlternativeNames(java.lang.String subjectAlternativeNames) |
Sets the subject alternative names.
|
void |
setSubjectCommonName(java.lang.String subjectCommonName) |
Sets the preferred endpoint identity for the Subject common name and
first Subject Alternative Name.
|
void |
setSubjectNamePolicy(java.lang.String subjectNamePolicy) |
Sets the policy used to authorize Domain Certificates Issuer subject
names.
|
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSetaddPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListenergetAttribute, getAttributes, invoke, setAttribute, setAttributespostDeregister, postRegister, preDeregister, preRegisteraddNotificationListener, getNotificationInfo, removeNotificationListenergetMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParentboolean isEnabled()
Returns true or false to indicate whether the Certificate Management Service is enabled or not.
void setEnabled(boolean isEnabled)
Enables or disables the Certificate Management Service.
isEnabled - True to enable or false to disable.boolean isProvisionedCertificatesIssuerEnabled()
Returns true or false to indicate whether the Provisioned Certificates Issuer is enabled or not.
void setProvisionedCertificatesIssuerEnabled(boolean isProvisionedCertificatesIssuerEnabled)
Enables or disables the Provisioned Certificates Issuer.
isProvisionedCertificatesIssuerEnabled - True to enable or false to disableint getCertificateCheckInterval()
Returns the certificate check interval -- how often the Certificate Management Service should check for/refresh expiring certificates (in days).
void setCertificateCheckInterval(int certificateCheckInterval)
Sets the certificate check interval (in days).
certificateCheckInterval - The number of days between certificate checksboolean isKeystoreFileWatchingEnabled()
Returns whether WebLogic Server watches Certificate Management keystore files for changes made by another process.
This process-lifetime setting requires a server restart. Node Manager
uses the matching KeystoreFileWatchingEnabled property in
nodemanager.properties. The
weblogic.keystore.filewatch.enabled system property is a
bootstrap override and takes precedence when specified.
WebLogic Server and Node Manager enable watching by default. Set the
matching Node Manager property to false to disable both file
watching and managed-identity revision polling. When enabled, Node Manager
restarts after identity replacement or removal so a removed listener
credential is not retained.
void setKeystoreFileWatchingEnabled(boolean enabled)
Sets whether WebLogic Server watches Certificate Management keystore files for changes made by another process.
enabled - Whether Certificate Management keystore file watching is enabledboolean isKeystoreFileLockingEnabled()
Returns whether WebLogic Server uses cross-process file locks when accessing shared Certificate Management keystores.
This process-lifetime setting requires a server restart. Node Manager
uses the matching KeystoreFileLockingEnabled property in
nodemanager.properties. The
weblogic.keystore.filelock.enabled system property is a
bootstrap override and takes precedence when specified. If locking is
disabled, it must be disabled consistently in every process that accesses
the same machine keystores.
void setKeystoreFileLockingEnabled(boolean enabled)
Sets whether WebLogic Server uses cross-process file locks when accessing shared Certificate Management keystores.
enabled - Whether cross-process Certificate Management keystore locking is enabledlong getKeystoreFileLockTimeout()
Returns the maximum number of milliseconds WebLogic Server waits to acquire a cross-process Certificate Management keystore file lock.
This process-lifetime setting requires a server restart. Node Manager
uses the matching KeystoreFileLockTimeout property in
nodemanager.properties. The
weblogic.keystore.filelock.timeout system property is a bootstrap
override and takes precedence when specified.
void setKeystoreFileLockTimeout(long timeout)
Sets the maximum number of milliseconds WebLogic Server waits to acquire a cross-process Certificate Management keystore file lock.
timeout - The positive lock timeout in millisecondsjava.lang.String getCertificateCheckTime()
Returns the optional local server time at which the Certificate Management
Service begins each certificate check. The value uses H:mm format,
with an hour from 0 through 23 and a two-digit minute.
If this value is not set, the service retains its legacy fixed-rate
scheduling behavior. If it is set, the first check is scheduled for this
local time after the configured certificate check interval, and subsequent checks use the same
calendar-day interval.
void setCertificateCheckTime(java.lang.String certificateCheckTime)
Sets the optional local server time at which the Certificate Management Service begins each certificate check.
certificateCheckTime - The local time in H:mm format, or
null to use legacy fixed-rate schedulingint getCertificateCheckTimeMaximumOffset()
Returns the maximum random offset, in seconds, added to a configured certificate check time. The service samples one offset from zero through this value when the schedule is established, then reuses it for that scheduling lifecycle. An offset can move a check into the next local calendar date, but is always less than one day.
void setCertificateCheckTimeMaximumOffset(int certificateCheckTimeMaximumOffset)
Sets the maximum random offset, in seconds, added to a configured
certificate check time. A value of 0 disables the offset.
certificateCheckTimeMaximumOffset - The maximum offset in seconds,
from 0 through 86399int getExpiredCertificateAuthorityRetentionDays()
Returns the number of days an expired Certificate Authority remains
trusted in the Admin Server's domain-trust or
provisioned-trust source store before automatic cleanup removes
it.
A value of 0 disables automatic Certificate Authority
cleanup. It does not disable Administrator-initiated cleanup.
void setExpiredCertificateAuthorityRetentionDays(int expiredCertificateAuthorityRetentionDays)
Sets the number of days an expired Certificate Authority remains
trusted in the Admin Server's domain-trust or
provisioned-trust source store before automatic cleanup removes
it.
expiredCertificateAuthorityRetentionDays - The retention period in days; 0
disables automatic cleanupint getCertificateRefreshWindow()
Returns the certificate refresh window. The Certificate Management Service will refresh an expiring certificate when its remaining lifetime is less than this number of days.
void setCertificateRefreshWindow(int certificateRefreshWindow)
Sets the certificate refresh window (in days).
certificateRefreshWindow - How many days before expiration to refresh certificatesboolean isSinglePurposeCertificatesEnabled()
Returns the single purpose certificates enabled value: whether the Domain Certificates Issuer should generate separate, single-purpose certificates for different purposes (server authentication, client authentication, signing and encryption), or generate one certificate that supports all those purposes.
void setSinglePurposeCertificatesEnabled(boolean isSinglePurposeCertificatesEnabled)
Enables or disables single purpose certificates.
isSinglePurposeCertificatesEnabled - True to enable or false to disablejava.lang.String getCertificateKeyProfile()
Returns the configured leaf certificate key profile.
The dynamic profile is used when a future leaf certificate is generated or renewed. Updating it does not alter existing certificate material or force regeneration.
void setCertificateKeyProfile(java.lang.String certificateKeyProfile)
Sets the leaf certificate key profile.
certificateKeyProfile - The leaf certificate key profilejava.lang.String getCertificateAuthorityKeyProfile()
Returns the configured Certificate Authority key profile.
The dynamic profile is used for a future Domain or Machine Certificate Authority generation or rollover. Updating it does not alter existing CA material or force regeneration.
void setCertificateAuthorityKeyProfile(java.lang.String certificateAuthorityKeyProfile)
Sets the Certificate Authority key profile.
certificateAuthorityKeyProfile - The Certificate Authority key profilejava.lang.String getCertificateAuthoritySignatureAlgorithm()
Returns the configured signature algorithm for Certificate Authorities.
A future Certificate Authority uses this algorithm to sign both its self-signed certificate and the leaf certificates it issues. An existing Certificate Authority continues to use its current signer until it is regenerated or rolled over.
void setCertificateAuthoritySignatureAlgorithm(java.lang.String certificateAuthoritySignatureAlgorithm)
Sets the signature algorithm for Certificate Authorities.
certificateAuthoritySignatureAlgorithm - The Certificate Authority signature algorithmjava.lang.String getSubjectCommonName()
The fully qualified endpoint identity the Domain Certificates Issuer
should prefer for a server certificate's Subject common name and first
Subject Alternative Name: either the local hostname
(hostname) or the server's listen address
(listen_address).
If no fully qualified listen address is configured for the server, the fully qualified hostname will be used instead, regardless of the value set here. If neither is available, the authenticated host address is used as an IP Subject Alternative Name when permitted by the configured subject name policy.
When a fully qualified hostname is available, the Subject uses that
value in CN=fully-qualified-hostname and identifies the server
in OU=Server: server-name. When no fully qualified hostname is
available, the Subject instead identifies the server in
CN=Server: server-name and omits the server organizational unit.
The domain organizational unit is present in both forms.
void setSubjectCommonName(java.lang.String subjectCommonName)
Sets the preferred endpoint identity for the Subject common name and first Subject Alternative Name.
subjectCommonName - The subjectName value to setjava.lang.String getSubjectAlternativeNames()
A space- or comma-separated list of words representing the Subject Alternative Names that the Domain Certificates Issuer should include when generating a server certificate.
Each word must be one of the subject name constants defined by the CertificateConfigurationConstants interface. When generating a certificate, the Certificate Management Service replaces each constant with the corresponding value(s) obtained from the target server's configuration or the host it's running on.
Virtual host names are included only when the virtual host is targeted to the server for which the certificate is issued. A named virtual host, listen address, or network channel listen address that is not configured for that server is omitted without causing certificate issuance to fail.
The preferred endpoint identity selected by
getSubjectCommonName() is included even if it is not explicitly
configured here. When no fully qualified hostname is available, the
authenticated host address is included as an IP Subject Alternative Name
when permitted by the configured subject name policy.
void setSubjectAlternativeNames(java.lang.String subjectAlternativeNames)
Sets the subject alternative names.
subjectAlternativeNames - The subjectAlternativeNames to setjava.lang.String getSubjectNamePolicy()
Controls which host names and literal IP addresses the Domain Certificates Issuer may place in a certificate subject.
CONFIGURED_ONLY permits a server's configured listen address,
network-channel listen addresses, and targeted virtual-host names. For a
machine certificate it permits the configured Node Manager listen address.
CONFIGURED_PLUS_HOST additionally permits the hostname and address
authenticated in the certificate request. CONFIGURED_PLUS_ANY
retains legacy behavior and permits any requested identity. The
localhost DNS name and numeric loopback addresses are permitted in
every mode.
A server certificate request fails if its preferred endpoint identity
or any requested Subject Alternative Name is not permitted. A machine
certificate request silently discards names that are not permitted. It
prefers a permitted fully qualified hostname for the Subject common name.
If none is available, a permitted authenticated host address is placed in
an IP Subject Alternative Name and the Subject identifies the machine in
CN=Machine: machine-name without the machine organizational unit.
Under CONFIGURED_ONLY, this fallback is available when the
configured Node Manager listen address is that host address.
void setSubjectNamePolicy(java.lang.String subjectNamePolicy)
subjectNamePolicy - the subject name policyint getCertificateValidityPeriod()
Returns the validity period (certificate lifetime) that the Domain Certificates Issuer should set when generating a new certificate. The validity period is expressed in days.
void setCertificateValidityPeriod(int certificateValidityPeriod)
Sets the certificate validity period (in days).
certificateValidityPeriod - How many days new certificates will be valid for.int getCertificateAuthorityValidityPeriod()
Returns the validity period (certificate lifetime) that the Domain Certificates Issuer should set when generating a new Certificate Authority certificate. The validity period is expressed in days.
void setCertificateAuthorityValidityPeriod(int certificateAuthorityValidityPeriod)
Sets the certificate authority validity period (in days).
certificateAuthorityValidityPeriod - How many days new certificate authority certificates will be valid for.boolean isIncludeRootCertificateInChain()
Whether the Domain Certificates Issuer should include the self-signed root CA in the certificate chain for a generated certificate.
void setIncludeRootCertificateInChain(boolean isIncludeRootCertificateInChain)
Enables or disables inclusion of the self-signed root CA for Domain Certificates.
isIncludeRootCertificateInChain - The isIncludeRootCertificateInChain valueboolean isJavaStandardTrustEnabled()
Whether or not the domain should trust the Java Standard Trust certificates, in addition to the Domain Certificate Authority certificate(s) and any Provisioned Trust certificates. Java Standard Trust is a collection of well-known, trusted root certificate authorities distributed (and updated) as part of the JDK.
ServerTemplateMBean.getJavaStandardTrustKeyStorePassPhrase()void setJavaStandardTrustEnabled(boolean isJavaStandardTrustEnabled)
Whether or not the domain should trust the Java Standard Trust certificates in addition to the Domain Certificate Authority certificate(s) and any Provisioned Trust certificates.
isJavaStandardTrustEnabled - The isJavaStandardTrustEnabled valueCertificateIssuerPluginMBean[] getCertificateIssuerPlugins()
Returns the CertificateIssuerPlugins for this Domain.
CertificateIssuerPluginMBean createCertificateIssuerPlugin(java.lang.String name)
Creates a new CertificateIssuerPlugin instance in the domain
name - The name for the new CertificateIssuerPluginMBeanvoid destroyCertificateIssuerPlugin(CertificateIssuerPluginMBean certificateIssuerPluginMBean)
Deletes a CertificateIssuerPluginMBean
certificateIssuerPluginMBean - The certificateIssuerPluginMBean to deleteCertificateIssuerPluginMBean lookupCertificateIssuerPlugin(java.lang.String name)
Looks up a CertificateIssuerPluginMBean by name.
name - The name of the CertificateIssuerPluginMBean to find