Class CollectSupportDataExtendedRequestProperties
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.extensions.CollectSupportDataExtendedRequestProperties
-
- All Implemented Interfaces:
java.io.Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class CollectSupportDataExtendedRequestProperties extends java.lang.Object implements java.io.Serializable
This class defines a set of properties that may be used when creating aCollectSupportDataExtendedRequest
.
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.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CollectSupportDataExtendedRequestProperties()
Creates a new set of collect support data extended request properties with none of the properties set, indicating that the server should use the default values for all of them.CollectSupportDataExtendedRequestProperties(CollectSupportDataExtendedRequest request)
Creates a new set of collect support data extended request properties using the settings from the provided extended request.CollectSupportDataExtendedRequestProperties(CollectSupportDataExtendedRequestProperties properties)
Creates a new set of collect support data extended request properties that is a copy of the provided properties.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getArchiveFileName()
Retrieves the name (without any path information) that the client intends to use for the support data archive file.java.lang.String
getComment()
Retrieves an additional comment that should be included in the support data archive.ASN1OctetString
getEncryptionPassphrase()
Retrieves the passphrase that should be used to encrypt the contents of the support data archive.java.lang.Boolean
getIncludeBinaryFiles()
Retrieves the value of a flag that indicates whether the support data archive may include binary files.java.lang.Boolean
getIncludeExpensiveData()
Retrieves the value of a flag that indicates whether the support data archive may include data that is potentially expensive to collect and could affect the performance or responsiveness of the server.java.lang.Boolean
getIncludeExtensionSource()
Retrieves the value of a flag that indicates whether the support data archive should include source code (if available) for any third-party extensions installed in the server.java.lang.Boolean
getIncludeReplicationStateDump()
Retrieves the value of a flag that indicates whether the support data archive may include a replication state dump, which may be several megabytes in size.java.lang.Integer
getJStackCount()
Retrieves the number of times that the jstack utility should be invoked to obtain stack traces from all threads in the server.CollectSupportDataLogCaptureWindow
getLogCaptureWindow()
Retrieves the log capture window object that indicates how much log content should be included in the support data archive.java.lang.Integer
getMaximumFragmentSizeBytes()
Retrieves the maximum size, in bytes, that may be used for a support data archive fragment returned in any singleCollectSupportDataArchiveFragmentIntermediateResponse
message.java.lang.String
getProxyToServerAddress()
Retrieves the address of the backend Directory Server to which the collect support data extended request should be forwarded.java.lang.Integer
getProxyToServerPort()
Retrieves the port of the backend Directory Server to which the collect support data extended request should be forwarded.java.lang.Integer
getReportCount()
Retrieves the number of intervals that should be captured from tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).java.lang.Integer
getReportIntervalSeconds()
Retrieves the interval duration in seconds that should be used for tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).CollectSupportDataSecurityLevel
getSecurityLevel()
Retrieves the security level that should be used to indicate which data should be obscured, redacted, or omitted from the support data archive.java.lang.Boolean
getUseSequentialMode()
Retrieves the value of a flag that indicates whether the server should collect items for the support data archive in sequential mode rather than in parallel.void
setArchiveFileName(java.lang.String archiveFileName)
Specifies the name (without any path information) that the client intends to use for the support data archive file.void
setComment(java.lang.String comment)
Specifies an additional comment that should be included in the support data archive.void
setEncryptionPassphrase(byte[] encryptionPassphrase)
Specifies the passphrase that should be used to encrypt the contents of the support data archive.void
setEncryptionPassphrase(ASN1OctetString encryptionPassphrase)
Specifies the passphrase that should be used to encrypt the contents of the support data archive.void
setEncryptionPassphrase(java.lang.String encryptionPassphrase)
Specifies the passphrase that should be used to encrypt the contents of the support data archive.void
setIncludeBinaryFiles(java.lang.Boolean includeBinaryFiles)
Specifies the value of a flag that that indicates whether the support data archive may include binary files.void
setIncludeExpensiveData(java.lang.Boolean includeExpensiveData)
Specifies the value of a flag that indicates whether the support data archive may include data that is potentially expensive to collect and could affect the performance or responsiveness of the server.void
setIncludeExtensionSource(java.lang.Boolean includeExtensionSource)
Specifies the value of a flag that indicates whether the support data archive should include source code (if available) for any third-party extensions installed in the server.void
setIncludeReplicationStateDump(java.lang.Boolean includeReplicationStateDump)
Specifies the value of a flag that indicates whether the support data archive may include a replication state dump, which may be several megabytes in size.void
setJStackCount(java.lang.Integer jstackCount)
Specifies the number of times that the jstack utility should be invoked to obtain stack traces from all threads in the server.void
setLogCaptureWindow(CollectSupportDataLogCaptureWindow logCaptureWindow)
Specifies the log capture window object that indicates how much log content should be included in the support data archive.void
setMaximumFragmentSizeBytes(java.lang.Integer maximumFragmentSizeBytes)
Specifies the maximum size, in bytes, that may be used for a support data archive fragment returned in any singleCollectSupportDataArchiveFragmentIntermediateResponse
message.void
setProxyToServer(java.lang.String address, java.lang.Integer port)
Specifies the address and port of the backend Directory Server to which the collect support data extended request should be forwarded.void
setReportCount(java.lang.Integer reportCount)
Specifies the number of intervals that should be captured form tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).void
setReportIntervalSeconds(java.lang.Integer reportIntervalSeconds)
Specifies the interval duration in seconds that should be used for tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).void
setSecurityLevel(CollectSupportDataSecurityLevel securityLevel)
Specifies the security level that should be used to indicate which data should be obscured, redacted, or omitted from the support data archive.void
setUseSequentialMode(java.lang.Boolean useSequentialMode)
Specifies the value of a flag that indicates whether the server should collect items for the support data archive in sequential mode rather than in parallel.java.lang.String
toString()
Retrieves a string representation of this collect support data request properties object.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this collect support data request properties object to the provided buffer.
-
-
-
Constructor Detail
-
CollectSupportDataExtendedRequestProperties
public CollectSupportDataExtendedRequestProperties()
Creates a new set of collect support data extended request properties with none of the properties set, indicating that the server should use the default values for all of them.
-
CollectSupportDataExtendedRequestProperties
public CollectSupportDataExtendedRequestProperties(@NotNull CollectSupportDataExtendedRequestProperties properties)
Creates a new set of collect support data extended request properties that is a copy of the provided properties.- Parameters:
properties
- The set of properties to duplicate.
-
CollectSupportDataExtendedRequestProperties
public CollectSupportDataExtendedRequestProperties(@NotNull CollectSupportDataExtendedRequest request)
Creates a new set of collect support data extended request properties using the settings from the provided extended request.- Parameters:
request
- The collect support data extended request from which to set the property values.
-
-
Method Detail
-
getArchiveFileName
@Nullable public java.lang.String getArchiveFileName()
Retrieves the name (without any path information) that the client intends to use for the support data archive file.- Returns:
- The name (without any path information) that the client intends to
use for the support data archive file, or
null
if the server should generate an archive file name.
-
setArchiveFileName
public void setArchiveFileName(@Nullable java.lang.String archiveFileName)
Specifies the name (without any path information) that the client intends to use for the support data archive file.- Parameters:
archiveFileName
- The name (without any path information) that the client intends to use for the support data archive file. It may benull
if the server should generate an archive file name.
-
getEncryptionPassphrase
@Nullable public ASN1OctetString getEncryptionPassphrase()
Retrieves the passphrase that should be used to encrypt the contents of the support data archive.- Returns:
- The passphrase that should be used to encrypt the contents of the
support data archive, or
null
if the archive should not be encrypted.
-
setEncryptionPassphrase
public void setEncryptionPassphrase(@Nullable java.lang.String encryptionPassphrase)
Specifies the passphrase that should be used to encrypt the contents of the support data archive.- Parameters:
encryptionPassphrase
- The passphrase that should be used to encrypt the contents of the support data archive. It may benull
if the support data archive should not be encrypted.
-
setEncryptionPassphrase
public void setEncryptionPassphrase(@Nullable byte[] encryptionPassphrase)
Specifies the passphrase that should be used to encrypt the contents of the support data archive.- Parameters:
encryptionPassphrase
- The passphrase that should be used to encrypt the contents of the support data archive. It may benull
if the support data archive should not be encrypted.
-
setEncryptionPassphrase
public void setEncryptionPassphrase(@Nullable ASN1OctetString encryptionPassphrase)
Specifies the passphrase that should be used to encrypt the contents of the support data archive.- Parameters:
encryptionPassphrase
- The passphrase that should be used to encrypt the contents of the support data archive. It may benull
if the support data archive should not be encrypted.
-
getIncludeExpensiveData
@Nullable public java.lang.Boolean getIncludeExpensiveData()
Retrieves the value of a flag that indicates whether the support data archive may include data that is potentially expensive to collect and could affect the performance or responsiveness of the server.- Returns:
- The value of a flag that indicates whether the support data
archive may include data that is potentially expensive to collect,
or
null
if the property should not be specified when the request is created (in which case the server will use a default behavior of excluding expensive data).
-
setIncludeExpensiveData
public void setIncludeExpensiveData(@Nullable java.lang.Boolean includeExpensiveData)
Specifies the value of a flag that indicates whether the support data archive may include data that is potentially expensive to collect and could affect the performance or responsiveness of the server.- Parameters:
includeExpensiveData
- The value of a flag that indicates whether the support data archive may include data that is potentially expensive to collect. It may benull
if the flag should not be specified when the request is created (in which case the server will use a default behavior of excluding expensive data).
-
getIncludeReplicationStateDump
@Nullable public java.lang.Boolean getIncludeReplicationStateDump()
Retrieves the value of a flag that indicates whether the support data archive may include a replication state dump, which may be several megabytes in size.- Returns:
- The value of a flag that indicates whether the support data
archive may include a replication state dump, or
null
if the property should not be specified when the request is created (in which case the server will use a default behavior of excluding the state dump).
-
setIncludeReplicationStateDump
public void setIncludeReplicationStateDump(@Nullable java.lang.Boolean includeReplicationStateDump)
Specifies the value of a flag that indicates whether the support data archive may include a replication state dump, which may be several megabytes in size.- Parameters:
includeReplicationStateDump
- The value of a flag that indicates whether the support data archive may include a replication state dump. It may benull
if the flag should not be specified when the request is created (in which case the server will use a default behavior of excluding the state dump).
-
getIncludeBinaryFiles
@Nullable public java.lang.Boolean getIncludeBinaryFiles()
Retrieves the value of a flag that indicates whether the support data archive may include binary files.- Returns:
- The value of a flag that indicates whether the support data
archive may include binary files, or
null
if the property should not be specified when the request is created (in which case the server will use a default behavior of excluding binary files).
-
setIncludeBinaryFiles
public void setIncludeBinaryFiles(@Nullable java.lang.Boolean includeBinaryFiles)
Specifies the value of a flag that that indicates whether the support data archive may include binary files.- Parameters:
includeBinaryFiles
- The value of a flag that indicates whether the support data archive may include binary files. It may benull
if the property should not be specified when the request is created (in which case the server will use a default behavior of excluding binary files).
-
getIncludeExtensionSource
@Nullable public java.lang.Boolean getIncludeExtensionSource()
Retrieves the value of a flag that indicates whether the support data archive should include source code (if available) for any third-party extensions installed in the server.- Returns:
- The value of a flag that indicates whether the support data
archive should include source code (if available) for any
third-party extensions installed in the server, or
null
if the property should not be specified when the request is created (in which case the server will use a default behavior of excluding extension source code).
-
setIncludeExtensionSource
public void setIncludeExtensionSource(@Nullable java.lang.Boolean includeExtensionSource)
Specifies the value of a flag that indicates whether the support data archive should include source code (if available) for any third-party extensions installed in the server.- Parameters:
includeExtensionSource
- The value of a flag that indicates whether the support data archive should include source code (if available) for any third-party extensions in the server. It may benull
if the property should not be specified when the requets is created (in which case the server will use a default behavior of excluding extension source code).
-
getUseSequentialMode
@Nullable public java.lang.Boolean getUseSequentialMode()
Retrieves the value of a flag that indicates whether the server should collect items for the support data archive in sequential mode rather than in parallel. Collecting data in sequential mode may reduce the amount of memory consumed during the collection process, but it will take longer to complete.- Returns:
- The value of a flag that indicates whether the server should
collect items for the support data archive in sequential mode
rather than in parallel, or
null
if the property should not be specified when the request is created (in which case the server will default to capturing data in parallel).
-
setUseSequentialMode
public void setUseSequentialMode(@Nullable java.lang.Boolean useSequentialMode)
Specifies the value of a flag that indicates whether the server should collect items for the support data archive in sequential mode rather than in parallel. Collecting data in sequential mode may reduce the amount of memory consumed during the collection process, but it will take longer to complete.- Parameters:
useSequentialMode
- The value of a flag that indicates whether the server should collect items for the support data archive in sequential mode rather than in parallel. It may benull
if the property should not be specified when the request is created (in which case the server will default to capturing data in parallel).
-
getSecurityLevel
@Nullable public CollectSupportDataSecurityLevel getSecurityLevel()
Retrieves the security level that should be used to indicate which data should be obscured, redacted, or omitted from the support data archive.- Returns:
- The security level that should be used when creating the support
data archive, or
null
if the property should not be specified when the request is created (in which case the server will use a default security level).
-
setSecurityLevel
public void setSecurityLevel(@Nullable CollectSupportDataSecurityLevel securityLevel)
Specifies the security level that should be used to indicate which data should be obscured, redacted, or omitted from the support data archive.- Parameters:
securityLevel
- The security level that should be used when creating the support data archive. It may benull
if the property should not be specified when the request is created (in which case the server will use a default security level).
-
getJStackCount
@Nullable public java.lang.Integer getJStackCount()
Retrieves the number of times that the jstack utility should be invoked to obtain stack traces from all threads in the server.- Returns:
- The number of times that the jstack utility should be invoked to
obtain stack traces from all threads in the server, or
null
if the property should not be specified when the request is created (in which case the server will use a default count).
-
setJStackCount
public void setJStackCount(@Nullable java.lang.Integer jstackCount)
Specifies the number of times that the jstack utility should be invoked to obtain stack traces from all threads in the server.- Parameters:
jstackCount
- The number of times that the jstack utility should be invoked to obtain stack traces from all threads in the server. The value must not be negative, but it may be zero to indicate that the jstack utility should not be invoked. It may benull
if the property should not be specified when the request is created (in which case the server will use a default count).
-
getReportCount
@Nullable public java.lang.Integer getReportCount()
Retrieves the number of intervals that should be captured from tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).- Returns:
- The number of intervals that should be captured from tools that
use interval-based sampling, or
null
if the property should not be specified when the request is created (in which case the server will use a default report count).
-
setReportCount
public void setReportCount(@Nullable java.lang.Integer reportCount)
Specifies the number of intervals that should be captured form tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).- Parameters:
reportCount
- The number of intervals that should be captured from tools that use interval-based sampling. The value must not be negative, but it may be zero to indicate that no intervals should be captured. It may benull
if the property should not be specified when the request is created (in which case the server will use a default report count).
-
getReportIntervalSeconds
@Nullable public java.lang.Integer getReportIntervalSeconds()
Retrieves the interval duration in seconds that should be used for tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).- Returns:
- The interval duration in seconds that should be used for tools
that use interval-based sampling, or
null
if the property should not be specified when the request is created (in which case the server will use a default report interval).
-
setReportIntervalSeconds
public void setReportIntervalSeconds(@Nullable java.lang.Integer reportIntervalSeconds)
Specifies the interval duration in seconds that should be used for tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).- Parameters:
reportIntervalSeconds
- The interval duration in seconds that should be used for tools that use interval-based sampling. The value must be greater than or equal to one. It may benull
if the property should not be specified when the request is created (in which case the server will use a default report count).
-
getLogCaptureWindow
@Nullable public CollectSupportDataLogCaptureWindow getLogCaptureWindow()
Retrieves the log capture window object that indicates how much log content should be included in the support data archive.- Returns:
- The log capture window object that indicates how much log content
should be included in the support data archive, or
null
if this should not be specified in the request and the server should choose an appropriate amount of log content.
-
setLogCaptureWindow
public void setLogCaptureWindow(@Nullable CollectSupportDataLogCaptureWindow logCaptureWindow)
Specifies the log capture window object that indicates how much log content should be included in the support data archive.- Parameters:
logCaptureWindow
- The log capture window object that indicates how much log content should be included in the support data archive. It may benull
to indicate that the server should choose an appropriate amount of log content.
-
getComment
@Nullable public java.lang.String getComment()
Retrieves an additional comment that should be included in the support data archive.- Returns:
- An additional comment that should be included in the support data
archive, or
null
if no comment should be included.
-
setComment
public void setComment(@Nullable java.lang.String comment)
Specifies an additional comment that should be included in the support data archive.- Parameters:
comment
- An additional comment that should be included in the support data archive. It may benull
if no additional comment should be included.
-
getProxyToServerAddress
@Nullable public java.lang.String getProxyToServerAddress()
Retrieves the address of the backend Directory Server to which the collect support data extended request should be forwarded.- Returns:
- The address of the backend Directory Server to which the collect
support data extended request should be forwarded, or
null
if the request should be processed directly by the server that receives it.
-
getProxyToServerPort
@Nullable public java.lang.Integer getProxyToServerPort()
Retrieves the port of the backend Directory Server to which the collect support data extended request should be forwarded.- Returns:
- The port of the backend Directory Server to which the collect
support data extended request should be forwarded, or
null
if the request should be processed directly by the server that receives it.
-
setProxyToServer
public void setProxyToServer(@Nullable java.lang.String address, @Nullable java.lang.Integer port)
Specifies the address and port of the backend Directory Server to which the collect support data extended request should be forwarded. Either both arguments must benull
or both must be non-null
.- Parameters:
address
- The address of the backend Directory Server to which the request should be forwarded. It may benull
if the request should be processed directly by the server that receives it, in which case theport
value must also benull
. If it is non-null
, then it must also be non-empty.port
- The port of the backend Directory Server to which the request should be forwarded. It may benuoll
if the request should be processed directly by the server that receives it, in which case theaddress
value must also be non-null
. If it is non-null
, then the value must be between 1 and 65535, inclusive.
-
getMaximumFragmentSizeBytes
@Nullable public java.lang.Integer getMaximumFragmentSizeBytes()
Retrieves the maximum size, in bytes, that may be used for a support data archive fragment returned in any singleCollectSupportDataArchiveFragmentIntermediateResponse
message.- Returns:
- The maximum size, in bytes, that may be used for a support data
archive fragment in any single archive fragment intermediate
response message, or
null
if the server should use a default maximum fragment size.
-
setMaximumFragmentSizeBytes
public void setMaximumFragmentSizeBytes(@Nullable java.lang.Integer maximumFragmentSizeBytes)
Specifies the maximum size, in bytes, that may be used for a support data archive fragment returned in any singleCollectSupportDataArchiveFragmentIntermediateResponse
message.- Parameters:
maximumFragmentSizeBytes
- The maximum size, in bytes, that may be used for a support data archive fragment returned in any single archive fragment intermediate response message. It may benull
if the server should use a default maximum fragment size. If it is non-null
, then the value must also be greater than zero.
-
toString
@NotNull public java.lang.String toString()
Retrieves a string representation of this collect support data request properties object.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this collect support data request properties object.
-
-