/* * The contents of this file are subject to the terms of the Common Development and * Distribution License (the License). You may not use this file except in compliance with the * License. * * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the * specific language governing permission and limitations under the License. * * When distributing Covered Software, include this CDDL Header Notice in each file and include * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL * Header, with the fields enclosed by brackets [] replaced by your own identifying * information: "Portions Copyright [year] [name of copyright owner]". * * Copyright 2014-2016 ForgeRock AS. */ package com.forgerock.opendj.cli; /** * This class contains short and long options used by the argument in CLI. */ public final class ArgumentConstants { /** * The name of the SASL property that can be used to provide the * authentication ID for the bind. */ public static final String SASL_PROPERTY_AUTHID = "authid"; /** * The name of the SASL property that can be used to provide the * authorization ID for the bind. */ public static final String SASL_PROPERTY_AUTHZID = "authzid"; /** * The name of the SASL property that can be used to provide the digest URI * for the bind. */ public static final String SASL_PROPERTY_DIGEST_URI = "digest-uri"; /** * The name of the SASL property that can be used to provide the KDC for use * in Kerberos authentication. */ public static final String SASL_PROPERTY_KDC = "kdc"; /** * The name of the SASL property that can be used to provide the quality of * protection for the bind. */ public static final String SASL_PROPERTY_QOP = "qop"; /** * The name of the SASL property that can be used to provide the realm for * the bind. */ public static final String SASL_PROPERTY_REALM = "realm"; /** * The name of the SASL property that can be used to provide the SASL * mechanism to use. */ public static final String SASL_PROPERTY_MECH = "mech"; /** The value for the long option batch. */ public static final String OPTION_LONG_BATCH = "batch"; /** The value for the short option batchFilePath. */ public static final char OPTION_SHORT_BATCH_FILE_PATH = 'F'; /** The value for the long option batchFilePath. */ public static final String OPTION_LONG_BATCH_FILE_PATH = "batchFilePath"; /** The value for the short option host name. */ public static final char OPTION_SHORT_HOST = 'h'; /** The value for the long option host name. */ public static final String OPTION_LONG_HOST = "hostname"; /** The value for the short option port. */ public static final char OPTION_SHORT_PORT = 'p'; /** The value for the long option port. */ public static final String OPTION_LONG_PORT = "port"; /** The value for the short option useSSL. */ public static final char OPTION_SHORT_USE_SSL = 'Z'; /** The value for the long option useSSL. */ public static final String OPTION_LONG_USE_SSL = "useSSL"; /** The value for the short option baseDN. */ public static final char OPTION_SHORT_BASEDN = 'b'; /** The value for the long option baseDN. */ public static final String OPTION_LONG_BASEDN = "baseDN"; /** The value for the short option bindDN. */ public static final char OPTION_SHORT_BINDDN = 'D'; /** The value for the long option bindDN. */ public static final String OPTION_LONG_BINDDN = "bindDN"; /** The value for the short option bindPassword. */ public static final char OPTION_SHORT_BINDPWD = 'w'; /** The value for the long option bindPassword. */ public static final String OPTION_LONG_BINDPWD = "bindPassword"; /** The value for the short option bindPasswordFile. */ public static final char OPTION_SHORT_BINDPWD_FILE = 'j'; /** The value for the long option bindPasswordFile. */ public static final String OPTION_LONG_BINDPWD_FILE = "bindPasswordFile"; /** The value for the short option compress. */ public static final char OPTION_SHORT_COMPRESS = 'c'; /** The value for the long option compress. */ public static final String OPTION_LONG_COMPRESS = "compress"; /** The value for the short option filename. */ public static final char OPTION_SHORT_FILENAME = 'f'; /** The value for the long option filename. */ public static final String OPTION_LONG_FILENAME = "filename"; /** The value for the short option ldifFile. */ public static final char OPTION_SHORT_LDIF_FILE = 'l'; /** The value for the long option ldifFile. */ public static final String OPTION_LONG_LDIF_FILE = "ldifFile"; /** The value for the short option useStartTLS. */ public static final char OPTION_SHORT_START_TLS = 'q'; /** The value for the long option useStartTLS. */ public static final String OPTION_LONG_START_TLS = "useStartTLS"; /** The value for the short option randomSeed. */ public static final char OPTION_SHORT_RANDOM_SEED = 's'; /** The value for the long option randomSeed. */ public static final String OPTION_LONG_RANDOM_SEED = "randomSeed"; /** The value for the short option keyStorePath. */ public static final char OPTION_SHORT_KEYSTOREPATH = 'K'; /** The value for the long option keyStorePath. */ public static final String OPTION_LONG_KEYSTOREPATH = "keyStorePath"; /** The value for the short option trustStorePath. */ public static final char OPTION_SHORT_TRUSTSTOREPATH = 'P'; /** The value for the long option trustStorePath. */ public static final String OPTION_LONG_TRUSTSTOREPATH = "trustStorePath"; /** The value for the short option keyStorePassword. */ public static final char OPTION_SHORT_KEYSTORE_PWD = 'W'; /** The value for the long option keyStorePassword. */ public static final String OPTION_LONG_KEYSTORE_PWD = "keyStorePassword"; /** The value for the short option trustStorePassword. */ public static final char OPTION_SHORT_TRUSTSTORE_PWD = 'T'; /** The value for the long option trustStorePassword. */ public static final String OPTION_LONG_TRUSTSTORE_PWD = "trustStorePassword"; /** The value for the short option keyStorePasswordFile . */ public static final char OPTION_SHORT_KEYSTORE_PWD_FILE = 'u'; /** The value for the long option keyStorePasswordFile . */ public static final String OPTION_LONG_KEYSTORE_PWD_FILE = "keyStorePasswordFile"; /** The value for the short option keyStorePasswordFile . */ public static final char OPTION_SHORT_TRUSTSTORE_PWD_FILE = 'U'; /** The value for the long option keyStorePasswordFile . */ public static final String OPTION_LONG_TRUSTSTORE_PWD_FILE = "trustStorePasswordFile"; /** The value for the short option trustAll . */ public static final char OPTION_SHORT_TRUSTALL = 'X'; /** The value for the long option trustAll . */ public static final String OPTION_LONG_TRUSTALL = "trustAll"; /** The value for the short option certNickname . */ public static final char OPTION_SHORT_CERT_NICKNAME = 'N'; /** The value for the long option certNickname . */ public static final String OPTION_LONG_CERT_NICKNAME = "certNickname"; /** The value for the long option assertionFilter . */ public static final String OPTION_LONG_ASSERTION_FILE = "assertionFilter"; /** The value for the short option dry-run. */ public static final char OPTION_SHORT_DRYRUN = 'n'; /** The value for the long option dry-run. */ public static final String OPTION_LONG_DRYRUN = "dry-run"; /** The value for the short option help. */ public static final char OPTION_SHORT_HELP = 'H'; /** The value for the long option help. */ public static final String OPTION_LONG_HELP = "help"; /** The value for the long option cli. */ public static final String OPTION_LONG_CLI = "cli"; /** The value for the short option cli. */ public static final char OPTION_SHORT_CLI = 'i'; /** The value for the short option proxyAs. */ public static final char OPTION_SHORT_PROXYAUTHID = 'Y'; /** The value for the long option proxyAs. */ public static final String OPTION_LONG_PROXYAUTHID = "proxyAs"; /** The value for the short option saslOption. */ public static final char OPTION_SHORT_SASLOPTION = 'o'; /** The value for the long option saslOption. */ public static final String OPTION_LONG_SASLOPTION = "saslOption"; /** The value for the short option searchScope. */ public static final char OPTION_SHORT_SEARCHSCOPE = 's'; /** The value for the long option searchScope. */ public static final String OPTION_LONG_SEARCHSCOPE = "searchScope"; /** The value for the short option geteffectiverights control authzid. */ public static final char OPTION_SHORT_EFFECTIVERIGHTSUSER = 'g'; /** The value for the long option geteffectiverights control authzid. */ public static final String OPTION_LONG_EFFECTIVERIGHTSUSER = "getEffectiveRightsAuthzid"; /** The value for the short option geteffectiveights control attributes. */ public static final char OPTION_SHORT_EFFECTIVERIGHTSATTR = 'e'; /** * The value for the long option geteffectiverights control specific * attribute list. */ public static final String OPTION_LONG_EFFECTIVERIGHTSATTR = "getEffectiveRightsAttribute"; /** The value for the long option version. */ public static final char OPTION_SHORT_PRODUCT_VERSION = 'V'; /** The value for the long option version. */ public static final String OPTION_LONG_PRODUCT_VERSION = "version"; /** The value for the long "checkStoppability" {@link Argument}. */ public static final String OPTION_LONG_CHECK_STOPPABILITY = "checkStoppability"; /** The value for the long "windowsNetStop" {@link Argument}. */ public static final String OPTION_LONG_WINDOWS_NET_STOP = "windowsNetStop"; /** Value for the quiet option short form. */ public static final Character OPTION_SHORT_QUIET = 'Q'; /** Value for the quiet option long form. */ public static final String OPTION_LONG_QUIET = "quiet"; /** Value for non-interactive session short form. */ public static final Character OPTION_SHORT_NO_PROMPT = 'n'; /** Value for non-interactive session long form. */ public static final String OPTION_LONG_NO_PROMPT = "no-prompt"; /** Long form of script friendly option. */ public static final String OPTION_LONG_SCRIPT_FRIENDLY = "script-friendly"; /** Short form of script friendly option. */ public static final Character OPTION_SHORT_SCRIPT_FRIENDLY = 's'; /** Value for verbose option short form. */ public static final Character OPTION_SHORT_VERBOSE = 'v'; /** Value for verbose option long form. */ public static final String OPTION_LONG_VERBOSE = "verbose"; /** The value for the long option propertiesFilePAth . */ public static final String OPTION_LONG_PROP_FILE_PATH = "propertiesFilePath"; /** The value for the long option propertiesFilePAth . */ public static final String OPTION_LONG_NO_PROP_FILE = "noPropertiesFile"; /** Long form of referenced host name. */ public static final String OPTION_LONG_REFERENCED_HOST_NAME = "referencedHostName"; /** Long form of admin UID. */ public static final String OPTION_LONG_ADMIN_UID = "adminUID"; /** Long form of report authorization ID connection option. */ public static final String OPTION_LONG_REPORT_AUTHZ_ID = "reportAuthzID"; /** Long form of use password policy control connection option. */ public static final String OPTION_LONG_USE_PW_POLICY_CTL = "usePasswordPolicyControl"; /** Long form of use SASL external connection option. */ public static final String OPTION_LONG_USE_SASL_EXTERNAL = "useSASLExternal"; /** Long form of option for the command-line encoding option. */ public static final String OPTION_LONG_ENCODING = "encoding"; /** The value for the long option targetDN. */ public static final String OPTION_LONG_TARGETDN = "targetDN"; /** Long form of email notification upon completion option. */ public static final String OPTION_LONG_COMPLETION_NOTIFICATION_EMAIL = "completionNotify"; /** Short form of email notification upon completion option. */ public static final Character OPTION_SHORT_COMPLETION_NOTIFICATION_EMAIL = null; /** Long form of email notification upon error option. */ public static final String OPTION_LONG_ERROR_NOTIFICATION_EMAIL = "errorNotify"; /** Short form of email notification upon error option. */ public static final Character OPTION_SHORT_ERROR_NOTIFICATION_EMAIL = null; /** Long form of dependency option. */ public static final String OPTION_LONG_DEPENDENCY = "dependency"; /** Short form of dependency option. */ public static final Character OPTION_SHORT_DEPENDENCY = null; /** Long form of failed dependency action option. */ public static final String OPTION_LONG_FAILED_DEPENDENCY_ACTION = "failedDependencyAction"; /** Short form of failed dependency action option. */ public static final Character OPTION_SHORT_FAILED_DEPENDENCY_ACTION = null; /** The default separator to be used in tables. */ public static final String LIST_TABLE_SEPARATOR = ":"; /** The value for the short option output LDIF filename. */ public static final char OPTION_SHORT_OUTPUT_LDIF_FILENAME = 'o'; /** The value for the long option output LDIF filename. */ public static final String OPTION_LONG_OUTPUT_LDIF_FILENAME = "outputLDIF"; /** The value for the long option to automatically accept the license if present. */ public static final String OPTION_LONG_ACCEPT_LICENSE = "acceptLicense"; /** The value for the short option rootUserDN. */ public static final char OPTION_SHORT_ROOT_USER_DN = 'D'; /** The value for the long option rootUserDN. */ public static final String OPTION_LONG_ROOT_USER_DN = "rootUserDN"; /** The value for the long option connect timeout attribute. */ public static final String OPTION_LONG_CONNECT_TIMEOUT = "connectTimeout"; /** The value for the long option advanced. */ public static final String OPTION_LONG_ADVANCED = "advanced"; /** Display the equivalent non-interactive command. */ public static final String OPTION_LONG_DISPLAY_EQUIVALENT = "displayCommand"; /** The path where we write the equivalent non-interactive command. */ public static final String OPTION_LONG_EQUIVALENT_COMMAND_FILE_PATH = "commandFilePath"; /** The value for the short option remote . */ public static final char OPTION_SHORT_REMOTE = 'r'; /** The value for the long option remote . */ public static final String OPTION_LONG_REMOTE = "remote"; /** The value for the short option configClass. */ public static final char OPTION_SHORT_CONFIG_CLASS = 'C'; /** The value for the long option configClass. */ public static final String OPTION_LONG_CONFIG_CLASS = "configClass"; /** Value for the server root option short form. */ public static final Character OPTION_SHORT_SERVER_ROOT = 'R'; /** Value for the server root option long form. */ public static final String OPTION_LONG_SERVER_ROOT = "serverRoot"; /** Value for the control option short form. */ public static final Character OPTION_SHORT_CONTROL = 'J'; /** Value for the control option long form. */ public static final String OPTION_LONG_CONTROL = "control"; /** Recurring task option long form. */ public static final String OPTION_LONG_RECURRING_TASK = "recurringTask"; /** Recurring task option short form. */ public static final Character OPTION_SHORT_RECURRING_TASK = null; /** Subentries control option long form. */ public static final String OPTION_LONG_SUBENTRIES = "subEntries"; /** Subentries control option short form. */ public static final Character OPTION_SHORT_SUBENTRIES = null; /** Scheduled start date/time option long form. */ public static final String OPTION_LONG_START_DATETIME = "start"; /** Scheduled start date/time option short form. */ public static final Character OPTION_SHORT_START_DATETIME = 't'; /** Long form of admin password. */ public static final String OPTION_LONG_ADMIN_PWD = "adminPassword"; /** Long form of admin password file. */ public static final String OPTION_LONG_ADMIN_PWD_FILE = "adminPasswordFile"; /** * The name of the SASL property that can be used to provide trace information * for a SASL ANONYMOUS request. */ public static final String SASL_PROPERTY_TRACE = "trace"; /** The value for the long option force upgrade. */ public static final String OPTION_LONG_FORCE_UPGRADE = "force"; /** The value for the long option ignore errors. */ public static final String OPTION_LONG_IGNORE_ERRORS = "ignoreErrors"; /** Value for the restart option long form. */ public static final String OPTION_LONG_RESTART = "restart"; /** The value for the backend type long option. */ public static final String OPTION_LONG_BACKEND_TYPE = "backendType"; /** The value for the backend type short option. */ public static final Character OPTION_SHORT_BACKEND_TYPE = 't'; /** The value to use to read from stdin or write to stdout. */ public static final String USE_SYSTEM_STREAM_TOKEN = "-"; /** The value for the wrap column long option. */ public static final String OPTION_LONG_WRAP_COLUMN = "wrapColumn"; /** The value for the wrap column short option. */ public static final char OPTION_SHORT_WRAP_COLUMN = 't'; /** Prevent instantiation. */ private ArgumentConstants() { } }