Package com.unboundid.util.ssl
Class TrustStoreTrustManagerProperties
- java.lang.Object
-
- com.unboundid.util.ssl.TrustStoreTrustManagerProperties
-
- All Implemented Interfaces:
java.io.Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class TrustStoreTrustManagerProperties extends java.lang.Object implements java.io.Serializable
This class provides a data structure with information about properties to use when accessing theTrustStoreTrustManager
.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description TrustStoreTrustManagerProperties(java.io.File trustStoreFile)
Creates a new set of trust manage provider properties for the specified trust store file.TrustStoreTrustManagerProperties(java.lang.String trustStorePath)
Creates a new set of trust manage provider properties for the specified trust store file.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
allowNonFIPSInFIPSMode()
Indicates whether to allow access to a non-FIPS-compliant trust store even when operating in FIPS-compliant mode.boolean
examineValidityDates()
Indicates whether to reject a presented certificate chain if the current time is outside the validity window for any of the certificates in the chain.java.security.Provider
getProvider()
Retrieves the security provider to use to access the trust store, if a non-default provider should be used.java.lang.String
getTrustStoreFormat()
Retrieves the format for the target trust store, if specified.java.lang.String
getTrustStorePath()
Retrieves the path to the target trust store file.char[]
getTrustStorePIN()
Retrieves the PIN needed to access the contents of the trust store, if specified.void
setAllowNonFIPSInFIPSMode(boolean allowNonFIPSInFIPSMode)
Specifies whether to allow access to a non-FIPS-compliant trust store even when operating in FIPS-compliant mode.void
setExamineValidityDates(boolean examineValidityDates)
Specifies whether to reject a presented certificate chain if the current time is outside the validity window for any of the certificates in the chain.void
setProvider(java.security.Provider provider)
Specifies the security provider to use to access the trust store.void
setTrustStoreFile(java.io.File trustStoreFile)
Specifies the target trust store file.void
setTrustStoreFormat(java.lang.String trustStoreFormat)
Specifies the format for the target trust store.void
setTrustStorePath(java.lang.String trustStorePath)
Specifies the path to the target trust store file.void
setTrustStorePIN(char[] trustStorePIN)
Specifies the PIN needed to access the contents of the trust store.void
setTrustStorePIN(java.lang.String trustStorePIN)
Specifies the PIN needed to access the contents of the trust store.java.lang.String
toString()
Retrieves a string representation of these properties.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of these properties to the provided buffer.
-
-
-
Constructor Detail
-
TrustStoreTrustManagerProperties
public TrustStoreTrustManagerProperties(@NotNull java.io.File trustStoreFile)
Creates a new set of trust manage provider properties for the specified trust store file.- Parameters:
trustStoreFile
- The target trust store file. It must not benull
.
-
TrustStoreTrustManagerProperties
public TrustStoreTrustManagerProperties(@NotNull java.lang.String trustStorePath)
Creates a new set of trust manage provider properties for the specified trust store file.- Parameters:
trustStorePath
- The path to the target trust store file. It must not benull
.
-
-
Method Detail
-
getTrustStorePath
@NotNull public java.lang.String getTrustStorePath()
Retrieves the path to the target trust store file.- Returns:
- The path to the target trust store file.
-
setTrustStoreFile
public void setTrustStoreFile(@NotNull java.io.File trustStoreFile)
Specifies the target trust store file.- Parameters:
trustStoreFile
- The target trust store file. It must not benull
.
-
setTrustStorePath
public void setTrustStorePath(@NotNull java.lang.String trustStorePath)
Specifies the path to the target trust store file.- Parameters:
trustStorePath
- The path to the target trust store file. It must not benull
.
-
getTrustStorePIN
@Nullable public char[] getTrustStorePIN()
Retrieves the PIN needed to access the contents of the trust store, if specified.- Returns:
- The PIN needed to access the contents of the trust store, or
null
if none has been specified.
-
setTrustStorePIN
public void setTrustStorePIN(@Nullable char[] trustStorePIN)
Specifies the PIN needed to access the contents of the trust store.- Parameters:
trustStorePIN
- The PIN needed to access the contents of the trust store. It may benull
if no PIN is needed.
-
setTrustStorePIN
public void setTrustStorePIN(@Nullable java.lang.String trustStorePIN)
Specifies the PIN needed to access the contents of the trust store.- Parameters:
trustStorePIN
- The PIN needed to access the contents of the trust store. It may benull
if no PIN is needed.
-
getTrustStoreFormat
@Nullable public java.lang.String getTrustStoreFormat()
Retrieves the format for the target trust store, if specified.- Returns:
- The format for the target trust store, or
null
if a default format should be used.
-
setTrustStoreFormat
public void setTrustStoreFormat(@Nullable java.lang.String trustStoreFormat)
Specifies the format for the target trust store.- Parameters:
trustStoreFormat
- The format for the target trust store. It may benull
if a default format should be used.
-
examineValidityDates
public boolean examineValidityDates()
Indicates whether to reject a presented certificate chain if the current time is outside the validity window for any of the certificates in the chain.- Returns:
true
if the trust manager should reject the certificate chain if the current time is outside the validity window for any of the certificates in the chain, orfalse
if not.
-
setExamineValidityDates
public void setExamineValidityDates(boolean examineValidityDates)
Specifies whether to reject a presented certificate chain if the current time is outside the validity window for any of the certificates in the chain.- Parameters:
examineValidityDates
- Indicates whether to reject a presented certificate chain if the current time is outside the validity window for any of the certificates in the chain.
-
getProvider
@Nullable public java.security.Provider getProvider()
Retrieves the security provider to use to access the trust store, if a non-default provider should be used.- Returns:
- The security provider to use to access the trust store, or
null
if a default provider should be used.
-
setProvider
public void setProvider(@Nullable java.security.Provider provider)
Specifies the security provider to use to access the trust store.- Parameters:
provider
- The security provider to use to access the trust store. It may benull
if a default provider should be used.
-
allowNonFIPSInFIPSMode
public boolean allowNonFIPSInFIPSMode()
Indicates whether to allow access to a non-FIPS-compliant trust store even when operating in FIPS-compliant mode.- Returns:
true
if access to a non-FIPS-compliant trust store should be allowed even when operating in FIPS-compliant mode, orfalse
if not.
-
setAllowNonFIPSInFIPSMode
public void setAllowNonFIPSInFIPSMode(boolean allowNonFIPSInFIPSMode)
Specifies whether to allow access to a non-FIPS-compliant trust store even when operating in FIPS-compliant mode.- Parameters:
allowNonFIPSInFIPSMode
- Indicates whether to allow access to a non-FIPS-compliant trust store even when operating in FIPS-compliant mode.
-
toString
@NotNull public java.lang.String toString()
Retrieves a string representation of these properties.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of these properties.
-
-