Package weblogic.management.runtime

Interface CertificateManagementDomainRuntimeMBean

All Superinterfaces:

javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface CertificateManagementDomainRuntimeMBean
extends RuntimeMBean

This class is used to monitor and manage certificate service runtime information at admin server.

Method Summary

Modifier and Type	Method	Description
void	purgeExpiredCertificateAuthorities()	Removes expired Certificate Authorities from the Admin Server's domain-trust and provisioned-trust source stores.
void	refreshServerCertificateAllServers(java.lang.String alias, boolean isActiveOnly, boolean isForceUpdate)	Refresh the certificate for alias alias on all servers.
void	refreshServerTrustAllServers()	Refresh domain trust on all the managed servers.
void	removeCertificateAuthority(java.lang.String sourceStore, java.lang.String alias)	Removes a selected Certificate Authority from an Admin Server source trust store.
void	rollDomainCertificateAuthority()	Generate a new self-signed CA certificate for the domain and refresh the trust stores for servers and machines.

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Method Detail

rollDomainCertificateAuthority

void rollDomainCertificateAuthority()
                             throws ManagementException

Generate a new self-signed CA certificate for the domain and refresh the trust stores for servers and machines.

Throws:

ManagementException

purgeExpiredCertificateAuthorities

void purgeExpiredCertificateAuthorities()
                                 throws ManagementException

Removes expired Certificate Authorities from the Admin Server's domain-trust and provisioned-trust source stores. This operation ignores the configured automatic cleanup retention period.

After a durable source deletion, this operation refreshes server and machine trust replicas. A refresh failure is reported after both refresh paths have been attempted; the source deletion is not rolled back.

Throws:

ManagementException

Access limited to the following security roles:

admin

removeCertificateAuthority

void removeCertificateAuthority(java.lang.String sourceStore,
                                java.lang.String alias)
                         throws ManagementException

Removes a selected Certificate Authority from an Admin Server source trust store.

The sourceStore value must be domain-trust or provisioned-trust. After a durable source deletion, this operation refreshes server and machine trust replicas. A refresh failure is reported after both refresh paths have been attempted; the source deletion is not rolled back.

Parameters:

sourceStore - the source trust store: domain-trust or provisioned-trust

alias - the Certificate Authority alias; aliases are case-insensitive

Throws:

ManagementException

Access limited to the following security roles:

admin

refreshServerTrustAllServers

void refreshServerTrustAllServers()
                           throws ManagementException

Refresh domain trust on all the managed servers.

Throws:

ManagementException

Access limited to the following security roles:

Operator

refreshServerCertificateAllServers

void refreshServerCertificateAllServers(java.lang.String alias,
                                        boolean isActiveOnly,
                                        boolean isForceUpdate)
                                 throws ManagementException

Refresh the certificate for alias alias on all servers. The authenticated WebLogic caller's identity is delegated to each Managed Server and, when required, to the Admin Server certificate service.

Parameters:

alias - The alias of the certificate to refresh. Aliases are case-insensitive.

isActiveOnly - If true, the certificate will only be refreshed if the alias is in use by an enabled channel or service, or is a built-in Domain PKI alias. If false, any valid alias may be refreshed, including an alias not yet configured for a server. This permits certificate pre-provisioning before a channel or service is enabled.

isForceUpdate - If true, force the certificate to be updated even if it is already present and valid. Normally, certificates are only updated if they are missing or invalid (expired).

Throws:

ManagementException

Access limited to the following security roles:

Operator