Class ManageAccount

  • All Implemented Interfaces:
    UnsolicitedNotificationHandler

    @ThreadSafety(level=NOT_THREADSAFE)
    public final class ManageAccount
    extends LDAPCommandLineTool
    implements UnsolicitedNotificationHandler
    This class provides a tool that can be used to perform a variety of account management functions against user entries in the Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 Directory Server. It primarily uses the password policy state extended operation for its processing.
    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.
    • Constructor Detail

      • ManageAccount

        public ManageAccount​(@Nullable
                             java.io.OutputStream out,
                             @Nullable
                             java.io.OutputStream err)
        Creates a new instance of this tool with the provided arguments.
        Parameters:
        out - The output stream to use for standard out. It may be null if standard out should be suppressed.
        err - The output stream to use for standard error. It may be null if standard error should be suppressed.
    • Method Detail

      • main

        public static void main​(@NotNull
                                java.lang.String... args)
        Invokes the tool with the provided set of arguments.
        Parameters:
        args - The command-line arguments provided to this tool.
      • main

        @NotNull
        public static ResultCode main​(@Nullable
                                      java.io.OutputStream out,
                                      @Nullable
                                      java.io.OutputStream err,
                                      @NotNull
                                      java.lang.String... args)
        Invokes the tool with the provided set of arguments.
        Parameters:
        out - The output stream to use for standard out. It may be null if standard out should be suppressed.
        err - The output stream to use for standard error. It may be null if standard error should be suppressed.
        args - The command-line arguments provided to this tool.
        Returns:
        A result code with the status of the tool processing. Any result code other than ResultCode.SUCCESS should be considered a failure.
      • getToolName

        @NotNull
        public java.lang.String getToolName()
        Retrieves the name of this tool. It should be the name of the command used to invoke this tool.
        Specified by:
        getToolName in class CommandLineTool
        Returns:
        The name for this tool.
      • supportsInteractiveMode

        public boolean supportsInteractiveMode()
        Indicates whether this tool should provide support for an interactive mode, in which the tool offers a mode in which the arguments can be provided in a text-driven menu rather than requiring them to be given on the command line. If interactive mode is supported, it may be invoked using the "--interactive" argument. Alternately, if interactive mode is supported and CommandLineTool.defaultsToInteractiveMode() returns true, then interactive mode may be invoked by simply launching the tool without any arguments.
        Overrides:
        supportsInteractiveMode in class CommandLineTool
        Returns:
        true if this tool supports interactive mode, or false if not.
      • supportsPropertiesFile

        public boolean supportsPropertiesFile()
        Indicates whether this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line.
        Overrides:
        supportsPropertiesFile in class CommandLineTool
        Returns:
        true if this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line, or false if not.
      • supportsOutputFile

        protected boolean supportsOutputFile()
        Indicates whether this tool should provide arguments for redirecting output to a file. If this method returns true, then the tool will offer an "--outputFile" argument that will specify the path to a file to which all standard output and standard error content will be written, and it will also offer a "--teeToStandardOut" argument that can only be used if the "--outputFile" argument is present and will cause all output to be written to both the specified output file and to standard output.
        Overrides:
        supportsOutputFile in class CommandLineTool
        Returns:
        true if this tool should provide arguments for redirecting output to a file, or false if not.
      • supportsDebugLogging

        protected boolean supportsDebugLogging()
        Indicates whether this tool supports the ability to generate a debug log file. If this method returns true, then the tool will expose additional arguments that can control debug logging.
        Overrides:
        supportsDebugLogging in class CommandLineTool
        Returns:
        true if this tool supports the ability to generate a debug log file, or false if not.
      • supportsAuthentication

        protected boolean supportsAuthentication()
        Indicates whether this tool should provide the arguments that allow it to bind via simple or SASL authentication.
        Overrides:
        supportsAuthentication in class LDAPCommandLineTool
        Returns:
        true if this tool should provide the arguments that allow it to bind via simple or SASL authentication, or false if not.
      • defaultToPromptForBindPassword

        protected boolean defaultToPromptForBindPassword()
        Indicates whether this tool should default to interactively prompting for the bind password if a password is required but no argument was provided to indicate how to get the password.
        Overrides:
        defaultToPromptForBindPassword in class LDAPCommandLineTool
        Returns:
        true if this tool should default to interactively prompting for the bind password, or false if not.
      • supportsSASLHelp

        protected boolean supportsSASLHelp()
        Indicates whether this tool should provide a "--help-sasl" argument that provides information about the supported SASL mechanisms and their associated properties.
        Overrides:
        supportsSASLHelp in class LDAPCommandLineTool
        Returns:
        true if this tool should provide a "--help-sasl" argument, or false if not.
      • includeAlternateLongIdentifiers

        protected boolean includeAlternateLongIdentifiers()
        Indicates whether the LDAP-specific arguments should include alternate versions of all long identifiers that consist of multiple words so that they are available in both camelCase and dash-separated versions.
        Overrides:
        includeAlternateLongIdentifiers in class LDAPCommandLineTool
        Returns:
        true if this tool should provide multiple versions of long identifiers for LDAP-specific arguments, or false if not.
      • supportsSSLDebugging

        protected boolean supportsSSLDebugging()
        Indicates whether this tool should provide a command-line argument that allows for low-level SSL debugging. If this returns true, then an "--enableSSLDebugging" argument will be added that sets the "javax.net.debug" system property to "all" before attempting any communication.
        Overrides:
        supportsSSLDebugging in class LDAPCommandLineTool
        Returns:
        true if this tool should offer an "--enableSSLDebugging" argument, or false if not.
      • supportsMultipleServers

        protected boolean supportsMultipleServers()
        Indicates whether this tool supports creating connections to multiple servers. If it is to support multiple servers, then the "--hostname" and "--port" arguments will be allowed to be provided multiple times, and will be required to be provided the same number of times. The same type of communication security and bind credentials will be used for all servers.
        Overrides:
        supportsMultipleServers in class LDAPCommandLineTool
        Returns:
        true if this tool supports creating connections to multiple servers, or false if not.
      • logToolInvocationByDefault

        protected boolean logToolInvocationByDefault()
        Indicates whether to log messages about the launch and completion of this tool into the invocation log of Ping Identity server products that may include it. This method is not needed for tools that are not expected to be part of the Ping Identity server products suite. Further, this value may be overridden by settings in the server's tool-invocation-logging.properties file.

        This method should generally return true for tools that may alter the server configuration, data, or other state information, and false for tools that do not make any changes.
        Overrides:
        logToolInvocationByDefault in class CommandLineTool
        Returns:
        true if Ping Identity server products should include messages about the launch and completion of this tool in tool invocation log files by default, or false if not.
      • getConnectionOptions

        @NotNull
        public LDAPConnectionOptions getConnectionOptions()
        Retrieves the connection options that should be used for connections that are created with this command line tool. Subclasses may override this method to use a custom set of connection options.
        Overrides:
        getConnectionOptions in class LDAPCommandLineTool
        Returns:
        The connection options that should be used for connections that are created with this command line tool.
      • registerShutdownHook

        protected boolean registerShutdownHook()
        Indicates whether this tool should register a shutdown hook with the JVM. Shutdown hooks allow for a best-effort attempt to perform a specified set of processing when the JVM is shutting down under various conditions, including:
        • When all non-daemon threads have stopped running (i.e., the tool has completed processing).
        • When System.exit() or Runtime.exit() is called.
        • When the JVM receives an external kill signal (e.g., via the use of the kill tool or interrupting the JVM with Ctrl+C).
        Shutdown hooks may not be invoked if the process is forcefully killed (e.g., using "kill -9", or the System.halt() or Runtime.halt() methods).

        If this method is overridden to return true, then the CommandLineTool.doShutdownHookProcessing(ResultCode) method should also be overridden to contain the logic that will be invoked when the JVM is shutting down in a manner that calls shutdown hooks.
        Overrides:
        registerShutdownHook in class CommandLineTool
        Returns:
        true if this tool should register a shutdown hook, or false if not.
      • doShutdownHookProcessing

        protected void doShutdownHookProcessing​(@Nullable
                                                ResultCode resultCode)
        Performs any processing that may be needed when the JVM is shutting down, whether because tool processing has completed or because it has been interrupted (e.g., by a kill or break signal).

        Note that because shutdown hooks run at a delicate time in the life of the JVM, they should complete quickly and minimize access to external resources. See the documentation for the java.lang.Runtime.addShutdownHook method for recommendations and restrictions about writing shutdown hooks.
        Overrides:
        doShutdownHookProcessing in class CommandLineTool
        Parameters:
        resultCode - The result code returned by the tool. It may be null if the tool was interrupted before it completed processing.
      • getExampleUsages

        @NotNull
        public java.util.LinkedHashMap<java.lang.String[],​java.lang.String> getExampleUsages()
        Retrieves a set of information that may be used to generate example usage information. Each element in the returned map should consist of a map between an example set of arguments and a string that describes the behavior of the tool when invoked with that set of arguments.
        Overrides:
        getExampleUsages in class CommandLineTool
        Returns:
        A set of information that may be used to generate example usage information. It may be null or empty if no example usage information is available.