ToolConstants.java revision fbbcdae277f66a56a2e5450858b249f82470dc56
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
* add the following below this CDDL HEADER, with the fields enclosed
* by brackets "[]" replaced with your own identifying information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
*/
/**
* This class defines a number of constants used in one or more Directory Server
* tools.
*/
public class ToolConstants
{
/**
* The name of the SASL property that can be used to provide the
* authentication ID for the bind.
*/
/**
* The name of the SASL property that can be used to provide the authorization
* ID for the bind.
*/
/**
* The name of the SASL property that can be used to provide the digest URI
* for the bind.
*/
/**
* The name of the SASL property that can be used to provide the KDC for use
* in Kerberos authentication.
*/
/**
* The name of the SASL property that can be used to provide the quality of
* protection for the bind.
*/
/**
* The name of the SASL property that can be used to provide the realm for the
* bind.
*/
/**
* The name of the SASL property that can be used to provide trace information
* for a SASL ANONYMOUS request.
*/
/**
* The name of the opends configuration direction in the user
* home directory.
*/
/**
* The default properties file name.
*/
public static final String DEFAULT_OPENDS_PROPERTIES_FILE_NAME =
"tools";
/**
* The default properties file extension.
*/
public static final String DEFAULT_OPENDS_PROPERTIES_FILE_EXTENSION =
".properties";
/**
* The value for the short option configClass.
*/
public static final char OPTION_SHORT_CONFIG_CLASS = 'C';
/**
* The value for the long option configClass.
*/
/**
* The value for the short option hostname.
*/
public static final char OPTION_SHORT_HOST = 'h';
/**
* The value for the long option hostname.
*/
/**
* The value for the short option port.
*/
public static final char OPTION_SHORT_PORT = 'p';
/**
* The value for the long option port.
*/
/**
* The value for the short option useSSL.
*/
public static final char OPTION_SHORT_USE_SSL = 'Z';
/**
* The value for the long option useSSL.
*/
/**
* The value for the short option baseDN.
*/
public static final char OPTION_SHORT_BASEDN = 'b';
/**
* The value for the long option baseDN.
*/
/**
* The value for the short option rootUserDN.
*/
public static final char OPTION_SHORT_ROOT_USER_DN = 'D';
/**
* The value for the long option rootUserDN.
*/
/**
* The value for the short option bindDN.
*/
public static final char OPTION_SHORT_BINDDN = 'D';
/**
* The value for the long option bindDN.
*/
/**
* The value for the short option bindPassword.
*/
public static final char OPTION_SHORT_BINDPWD = 'w';
/**
* The value for the long option bindPassword.
*/
/**
* The value for the short option bindPasswordFile.
*/
public static final char OPTION_SHORT_BINDPWD_FILE = 'j';
/**
* The value for the long option bindPasswordFile.
*/
/**
* The value for the short option compress.
*/
public static final char OPTION_SHORT_COMPRESS = 'c';
/**
* The value for the long option compress.
*/
/**
* The value for the short option filename.
*/
public static final char OPTION_SHORT_FILENAME = 'f';
/**
* The value for the long option filename.
*/
/**
* The value for the short option ldifFile.
*/
public static final char OPTION_SHORT_LDIF_FILE = 'l';
/**
* The value for the long option ldifFile.
*/
/**
* The value for the short option useStartTLS.
*/
public static final char OPTION_SHORT_START_TLS = 'q';
/**
* The value for the long option useStartTLS.
*/
/**
* The value for the short option randomSeed.
*/
public static final char OPTION_SHORT_RANDOM_SEED = 's';
/**
* The value for the long option randomSeed.
*/
/**
* The value for the short option keyStorePath.
*/
public static final char OPTION_SHORT_KEYSTOREPATH = 'K';
/**
* The value for the long option keyStorePath.
*/
/**
* The value for the short option trustStorePath.
*/
public static final char OPTION_SHORT_TRUSTSTOREPATH = 'P';
/**
* The value for the long option trustStorePath.
*/
/**
* The value for the short option keyStorePassword.
*/
public static final char OPTION_SHORT_KEYSTORE_PWD = 'W';
/**
* The value for the long option keyStorePassword.
*/
/**
* The value for the short option trustStorePassword.
*/
public static final char OPTION_SHORT_TRUSTSTORE_PWD = 'T';
/**
* The value for the long option 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 .
*/
/**
* The value for the short option certNickname .
*/
public static final char OPTION_SHORT_CERT_NICKNAME = 'N';
/**
* The value for the long option certNickname .
*/
/**
* The value for the long option 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.
*/
/**
* The value for the short option help.
*/
public static final char OPTION_SHORT_HELP = 'H';
/**
* The value for the long option help.
*/
/**
* The value for the long option 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.
*/
/**
* The value for the short option saslOption.
*/
public static final char OPTION_SHORT_SASLOPTION = 'o';
/**
* The value for the long option saslOption.
*/
/**
* 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 short option protocol version attributes.
*/
public static final char OPTION_SHORT_PROTOCOL_VERSION = 'V';
/**
* The value for the long option protocol version
* attribute.
*/
public static final String OPTION_LONG_PROTOCOL_VERSION =
"ldapVersion";
/**
* The value for the long option version.
*/
public static final char OPTION_SHORT_PRODUCT_VERSION = 'V';
/**
* The value for the long option version.
*/
/**
* The value for the short option description attributes.
*/
public static final char OPTION_SHORT_DESCRIPTION = 'd';
/**
* The value for the long option description attribute.
*/
/**
* The value for the short option groupName attributes.
*/
public static final char OPTION_SHORT_GROUPNAME = 'g';
/**
* The value for the long option groupName
* attribute.
*/
/**
* The value for the short option newGroupName attribute.
*/
public static final char OPTION_SHORT_NEWGROUPNAME = 'n';
/**
* The value for the long option groupName
* attribute.
*/
/**
* The value for the short option member-name attributes.
*/
public static final char OPTION_SHORT_MEMBERNAME = 'm';
/**
* The value for the long member-name version
* attribute.
*/
/**
* The value for the short option backendName attributes.
*/
public static final char OPTION_SHORT_BACKENDNAME = 'b';
/**
* The value for the long option backendName
* attribute.
*/
/**
* The value for the short option serverID attributes.
*/
/**
* The value for the long option serverID
* attribute.
*/
/**
* The value for the short option userID attributes.
*/
/**
* The value for the long option userID
* attribute.
*/
/**
* The value for the short option set.
*/
/**
* The value for the long option set.
*/
/**
* Value for the server root option short form.
*/
/**
* Value for the server root option long form.
*/
/**
* Value for the quiet option short form.
*/
/**
* Value for the quiet option long form.
*/
/**
* Value for noninteractive session short form.
*/
/**
* Value for noninteractive session long form.
*/
/**
* Long form of script friendly option.
*/
/**
* Short form of script friendly option.
*/
/**
* Value for verbose option short form.
*/
/**
* Value for verbose option long form.
*/
/**
*/
/**
*/
/**
* The value for the long option propertiesFilePAth .
*/
/**
* Argument that specifies that an operation be scheduled as a
* task but the scheduling utility should not exit until the task
* has completed.
*/
public static final String OPTION_LONG_SYNCHRONOUS_TASK_MODE =
"synchronousTaskMode";
/**
* Argument that specifies that an operation be scheduled as a
* task but the scheduling utility should not exit until the task
* has completed.
*/
/**
* The value for the long option propertiesFilePAth .
*/
/**
* Long form of referenced host name.
*/
public static final String OPTION_LONG_REFERENCED_HOST_NAME =
"referencedHostName";
/**
* Long form of admin UID.
*/
/**
* Long form of report authorization ID connection option.
*/
/**
* 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.
*/
/**
* Long form of option for the command-line encoding option.
*/
/**
* Long form of option specifying no wrapping of the command-line.
*/
/**
* 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.
*/
/**
* Short form of dependency option.
*/
/**
* Long form of failed dependency action option.
*/
public static final String OPTION_LONG_FAILED_DEPENDENCY_ACTION =
"failedDependencyAction";
/**
* Short form of failed dependency action option.
*/
/**
* The default separator to be used in tables.
*/
}