Class X509CertificateMonitorEntry
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
-
- com.unboundid.ldap.sdk.unboundidds.monitors.X509CertificateMonitorEntry
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class X509CertificateMonitorEntry extends MonitorEntry
This class defines a monitor entry that provides information about X.509 certificates that are in use by the Directory Server.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
The set of certificate monitor entries published by the directory server can be obtained using theMonitorManager.getX509CertificateMonitorEntries(com.unboundid.ldap.sdk.LDAPConnection)
method. Specific methods are available for accessing the associated monitor data (e.g.,getSubjectDN()
to retrieve the certificate's subject DN), and there are also methods for accessing this information in a generic manner (e.g.,getMonitorAttributes()
to retrieve all of the monitor attributes). See theMonitorManager
class documentation for an example that demonstrates the use of the generic API for accessing monitor data.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description X509CertificateMonitorEntry(Entry entry)
Creates a new X.509 certificate monitor entry from the provided entry.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getAlias()
Retrieves the alias used to identify the certificate in the key store.java.lang.String
getComponentName()
Retrieves the name of the component with which the certificate is associated.java.lang.String
getComponentType()
Retrieves the type of component with which the certificate is associated.java.lang.String
getContextType()
Retrieves the context in which the certificate is being used.java.lang.Boolean
getCurrentlyValid()
Indicates whether the certificate is currently within its validity window.java.util.List<java.lang.String>
getDependentComponents()
Retrieves the names of any components that depend on the certificate.java.lang.String
getHumanReadableTimeUntilExpiration()
Retrieves a human-readable representation of the length of time until the certificate expires.java.lang.String
getInvalidReason()
Retrieves the reason that the certificate is considered invalid.java.lang.String
getIssuerSubjectDN()
Retrieves the subject DN for the certificate's issuer.java.lang.String
getKeyStoreFile()
Retrieves the path to the key store file in which the certificate is held.java.lang.String
getKeyStoreType()
Retrieves the type of key store in which the certificate is held.java.util.Map<java.lang.String,MonitorAttribute>
getMonitorAttributes()
Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.java.lang.String
getMonitorDescription()
Retrieves a human-readable description name for this monitor entry.java.lang.String
getMonitorDisplayName()
Retrieves a human-readable display name for this monitor entry.java.util.Date
getNotValidAfter()
Retrieves the latest time that the certificate should be considered valid.java.util.Date
getNotValidBefore()
Retrieves the earliest time that the certificate should be considered valid.java.util.List<java.lang.String>
getProperties()
Retrieves a list of context-specific properties for the certificate.java.lang.String
getProviderType()
Retrieves the type of provider in which the certificate is held.java.lang.Long
getSecondsUntilExpiration()
Retrieves the length of time in seconds until the certificate expires.java.lang.String
getSerialNumber()
Retrieves a string representation of the certificate's serial number.java.lang.String
getSubjectDN()
Retrieves the subject DN for the certificate.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, decode, getBoolean, getDate, getDN, getDouble, getEntry, getInteger, getLong, getMonitorClass, getMonitorName, getString, getStrings, toString, toString
-
-
-
-
Constructor Detail
-
X509CertificateMonitorEntry
public X509CertificateMonitorEntry(@NotNull Entry entry)
Creates a new X.509 certificate monitor entry from the provided entry.- Parameters:
entry
- The entry to be parsed as an X.509 certificate monitor entry. It must not benull
.
-
-
Method Detail
-
getSubjectDN
@Nullable public java.lang.String getSubjectDN()
Retrieves the subject DN for the certificate.- Returns:
- The subject DN for the certificate, or
null
if it was not included in the monitor entry.
-
getIssuerSubjectDN
@Nullable public java.lang.String getIssuerSubjectDN()
Retrieves the subject DN for the certificate's issuer.- Returns:
- The subject DN for the certificate's issuer, or
null
if it was not included in the monitor entry.
-
getNotValidBefore
@Nullable public java.util.Date getNotValidBefore()
Retrieves the earliest time that the certificate should be considered valid.- Returns:
- The earliest time that the certificate should be considered valid,
or
null
if it was not included in the monitor entry.
-
getNotValidAfter
@Nullable public java.util.Date getNotValidAfter()
Retrieves the latest time that the certificate should be considered valid.- Returns:
- The latest time that the certificate should be considered valid,
or
null
if it was not included in the monitor entry.
-
getSecondsUntilExpiration
@Nullable public java.lang.Long getSecondsUntilExpiration()
Retrieves the length of time in seconds until the certificate expires.- Returns:
- The length of time in seconds until the certificate expires, or
null
if it was not included in the monitor entry.
-
getHumanReadableTimeUntilExpiration
@Nullable public java.lang.String getHumanReadableTimeUntilExpiration()
Retrieves a human-readable representation of the length of time until the certificate expires.- Returns:
- A human-readable representation of the length of time until the
certificate expires, or
null
if it was not included in the monitor entry.
-
getCurrentlyValid
@Nullable public java.lang.Boolean getCurrentlyValid()
Indicates whether the certificate is currently within its validity window.- Returns:
Boolean.TRUE
if the certificate is within its validity window,Boolean.FALSE
if it is outside its validity window, ornull
if it was not included in the monitor entry.
-
getInvalidReason
@Nullable public java.lang.String getInvalidReason()
Retrieves the reason that the certificate is considered invalid.- Returns:
- The reason that the certificate is considered invalid, or
null
if it was not included in the monitor entry.
-
getSerialNumber
@Nullable public java.lang.String getSerialNumber()
Retrieves a string representation of the certificate's serial number.- Returns:
- A string representation of the certificate's serial number, or
null
if it was not included in the monitor entry.
-
getContextType
@Nullable public java.lang.String getContextType()
Retrieves the context in which the certificate is being used.- Returns:
- The context in which the certificate is being used, or
null
if it was not included in the monitor entry.
-
getComponentType
@Nullable public java.lang.String getComponentType()
Retrieves the type of component with which the certificate is associated.- Returns:
- The type of component with which the certificate is associated, or
null
if it was not included in the monitor entry.
-
getComponentName
@Nullable public java.lang.String getComponentName()
Retrieves the name of the component with which the certificate is associated.- Returns:
- The name of the component with which the certificate is
associated, or
null
if it was not included in the monitor entry.
-
getKeyStoreType
@Nullable public java.lang.String getKeyStoreType()
Retrieves the type of key store in which the certificate is held.- Returns:
- The type of key store in which the certificate is held, or
null
if it was not included in the monitor entry.
-
getKeyStoreFile
@Nullable public java.lang.String getKeyStoreFile()
Retrieves the path to the key store file in which the certificate is held.- Returns:
- The path to the key store file in which the certificate is held,
or
null
if it was not included in the monitor entry.
-
getAlias
@Nullable public java.lang.String getAlias()
Retrieves the alias used to identify the certificate in the key store.- Returns:
- The alias used to identify the certificate in the key store, or
null
if it was not included in the monitor entry.
-
getProviderType
@Nullable public java.lang.String getProviderType()
Retrieves the type of provider in which the certificate is held.- Returns:
- The type of provider in which the certificate is held, or
null
if it was not included in the monitor entry.
-
getDependentComponents
@NotNull public java.util.List<java.lang.String> getDependentComponents()
Retrieves the names of any components that depend on the certificate.- Returns:
- The names of any components that depend on the certificate, or an empty list if it was not included in the monitor entry.
-
getProperties
@NotNull public java.util.List<java.lang.String> getProperties()
Retrieves a list of context-specific properties for the certificate.- Returns:
- A list of context-specific properties for the certificate, or an empty list if it was not included in the monitor entry.
-
getMonitorDisplayName
@NotNull public java.lang.String getMonitorDisplayName()
Retrieves a human-readable display name for this monitor entry.- Overrides:
getMonitorDisplayName
in classMonitorEntry
- Returns:
- A human-readable display name for this monitor entry.
-
getMonitorDescription
@NotNull public java.lang.String getMonitorDescription()
Retrieves a human-readable description name for this monitor entry.- Overrides:
getMonitorDescription
in classMonitorEntry
- Returns:
- A human-readable description name for this monitor entry.
-
getMonitorAttributes
@NotNull public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.- Overrides:
getMonitorAttributes
in classMonitorEntry
- Returns:
- The set of parsed monitor attributes for this monitor entry.
-
-