public final class ArgumentExceptionFactory extends Object
Modifier and Type | Method and Description |
---|---|
static com.forgerock.opendj.cli.ClientException |
adaptIllegalManagedObjectNameException(IllegalManagedObjectNameException e,
AbstractManagedObjectDefinition<?,?> d)
Creates a ClientException exception from an illegal managed object name exception.
|
static com.forgerock.opendj.cli.ArgumentException |
adaptPropertyException(PropertyException e,
AbstractManagedObjectDefinition<?,?> d)
Creates an argument exception from a property exception.
|
static void |
displayManagedObjectDecodingException(com.forgerock.opendj.cli.ConsoleApplication app,
ManagedObjectDecodingException e)
Displays a table listing reasons why a managed object could not be decoded successfully.
|
static void |
displayMissingMandatoryPropertyException(com.forgerock.opendj.cli.ConsoleApplication app,
MissingMandatoryPropertiesException e)
Displays a table listing missing mandatory properties.
|
static void |
displayOperationRejectedException(com.forgerock.opendj.cli.ConsoleApplication app,
OperationRejectedException e)
Displays a table listing the reasons why an operation was rejected.
|
static com.forgerock.opendj.cli.ArgumentException |
incompatiblePropertyModification(String arg)
Creates an argument exception which should be used when a property modification argument is incompatible with a
previous modification argument.
|
static com.forgerock.opendj.cli.ArgumentException |
missingBindPassword(char[] bindDN)
Creates an argument exception which should be used when the client has not specified a bind password.
|
static com.forgerock.opendj.cli.ArgumentException |
missingBindPassword(String bindDN)
Creates an argument exception which should be used when the client has not specified a bind password.
|
static com.forgerock.opendj.cli.ArgumentException |
missingMandatoryNonInteractiveArgument(com.forgerock.opendj.cli.Argument arg)
Creates an argument exception which should be used when an argument, which is mandatory when the application is
non-interactive, has not been specified.
|
static com.forgerock.opendj.cli.ArgumentException |
missingNameInPropertyArgument(String arg)
Creates an argument exception which should be used when a property value argument is invalid because it does not
a property name.
|
static com.forgerock.opendj.cli.ArgumentException |
missingNameInPropertyModification(String arg)
Creates an argument exception which should be used when a property modification argument is invalid because it
does not a property name.
|
static com.forgerock.opendj.cli.ArgumentException |
missingSeparatorInPropertyArgument(String arg)
Creates an argument exception which should be used when a property value argument is invalid because it does not
contain a separator between the property name and its value.
|
static com.forgerock.opendj.cli.ArgumentException |
missingSeparatorInPropertyModification(String arg)
Creates an argument exception which should be used when a property modification argument is invalid because it
does not contain a separator between the property name and its value.
|
static com.forgerock.opendj.cli.ArgumentException |
missingValueInPropertyArgument(String arg)
Creates an argument exception which should be used when a property value argument is invalid because it does not
a property value.
|
static com.forgerock.opendj.cli.ArgumentException |
missingValueInPropertyModification(String arg)
Creates an argument exception which should be used when a property modification argument is invalid because it
does not a property value.
|
static com.forgerock.opendj.cli.ArgumentException |
unableToReadBindPasswordInteractively()
Creates an argument exception which should be used when the bind password could not be read from the standard
input because the application is non-interactive.
|
static com.forgerock.opendj.cli.ArgumentException |
unableToReadConnectionParameters(Exception cause)
Creates an argument exception which should be used when the connection parameters could not be read from the
standard input.
|
static com.forgerock.opendj.cli.ArgumentException |
unableToResetMandatoryProperty(AbstractManagedObjectDefinition<?,?> d,
String name,
String setOption)
Creates an argument exception which should be used when an attempt is made to reset a mandatory property that
does not have any default values.
|
static com.forgerock.opendj.cli.ArgumentException |
unableToResetPropertyWithValue(String name,
String resetOption)
Creates an argument exception which should be used when an attempt is made to reset a property with a value.
|
static com.forgerock.opendj.cli.ArgumentException |
unableToSetNamingProperty(AbstractManagedObjectDefinition<?,?> d,
PropertyDefinition<?> pd)
Creates an argument exception which should be used when an attempt is made to set the naming property for a
managed object during creation.
|
static com.forgerock.opendj.cli.ArgumentException |
unknownCategory(String categoryName)
Creates an argument exception which should be used when a component category argument is not recognized.
|
static com.forgerock.opendj.cli.ArgumentException |
unknownProperty(AbstractManagedObjectDefinition<?,?> d,
String name)
Creates an argument exception which should be used when a property name is not recognized.
|
static com.forgerock.opendj.cli.ArgumentException |
unknownProperty(String name)
Creates an argument exception which should be used when a property name is not recognized.
|
static com.forgerock.opendj.cli.ArgumentException |
unknownSubType(RelationDefinition<?,?> r,
String typeName,
String typeUsage)
Creates an argument exception which should be used when a sub-type argument in a create-xxx sub-command is not
recognized.
|
static com.forgerock.opendj.cli.ArgumentException |
unknownTypeForCategory(String typeName,
String categoryName)
Creates an argument exception which should be used when a managed object type argument is not associated with a
category.
|
static com.forgerock.opendj.cli.ArgumentException |
unknownValueForChildComponent(String componentName)
Creates an argument exception which should be used when a child component does not exist.
|
static com.forgerock.opendj.cli.ArgumentException |
unknownValueForMultiValuedProperty(String value,
String propertyName)
Creates an argument exception which should be used when a multi-valued property does not contain a given value.
|
static com.forgerock.opendj.cli.ClientException |
wrongManagedObjectType(RelationDefinition<?,?> r,
ManagedObjectDefinition<?,?> d,
String subcommandName)
Creates a CLI exception which should be used when a managed object is retrieved but does not have the correct
type appropriate for the associated sub-command.
|
public static com.forgerock.opendj.cli.ClientException adaptIllegalManagedObjectNameException(IllegalManagedObjectNameException e, AbstractManagedObjectDefinition<?,?> d)
e
- The illegal managed object name exception.d
- The managed object definition.public static com.forgerock.opendj.cli.ArgumentException adaptPropertyException(PropertyException e, AbstractManagedObjectDefinition<?,?> d)
e
- The property exception.d
- The managed object definition.public static void displayManagedObjectDecodingException(com.forgerock.opendj.cli.ConsoleApplication app, ManagedObjectDecodingException e)
app
- The console application.e
- The managed object decoding exception.public static void displayMissingMandatoryPropertyException(com.forgerock.opendj.cli.ConsoleApplication app, MissingMandatoryPropertiesException e)
app
- The console application.e
- The missing mandatory property exception.public static void displayOperationRejectedException(com.forgerock.opendj.cli.ConsoleApplication app, OperationRejectedException e)
app
- The console application.e
- The operation rejected exception.public static com.forgerock.opendj.cli.ArgumentException incompatiblePropertyModification(String arg)
arg
- The incompatible argument.public static com.forgerock.opendj.cli.ArgumentException missingBindPassword(String bindDN)
bindDN
- The name of the user requiring a password.public static com.forgerock.opendj.cli.ArgumentException missingBindPassword(char[] bindDN)
bindDN
- The name of the user requiring a password.public static com.forgerock.opendj.cli.ArgumentException missingMandatoryNonInteractiveArgument(com.forgerock.opendj.cli.Argument arg)
arg
- The missing argument.public static com.forgerock.opendj.cli.ArgumentException missingNameInPropertyArgument(String arg)
arg
- The argument having the missing property name.public static com.forgerock.opendj.cli.ArgumentException missingNameInPropertyModification(String arg)
arg
- The argument having the missing property name.public static com.forgerock.opendj.cli.ArgumentException missingSeparatorInPropertyArgument(String arg)
arg
- The argument having a missing separator.public static com.forgerock.opendj.cli.ArgumentException missingSeparatorInPropertyModification(String arg)
arg
- The argument having a missing separator.public static com.forgerock.opendj.cli.ArgumentException missingValueInPropertyArgument(String arg)
arg
- The argument having the missing property value.public static com.forgerock.opendj.cli.ArgumentException missingValueInPropertyModification(String arg)
arg
- The argument having the missing property value.public static com.forgerock.opendj.cli.ArgumentException unableToReadConnectionParameters(Exception cause)
cause
- The reason why the connection parameters could not be read.public static com.forgerock.opendj.cli.ArgumentException unableToReadBindPasswordInteractively()
public static com.forgerock.opendj.cli.ArgumentException unableToResetMandatoryProperty(AbstractManagedObjectDefinition<?,?> d, String name, String setOption)
d
- The managed object definition.name
- The name of the mandatory property.setOption
- The name of the option which should be used to set the property's values.public static com.forgerock.opendj.cli.ArgumentException unableToResetPropertyWithValue(String name, String resetOption)
name
- The name of the mandatory property.resetOption
- The name of the option which should be used to reset the property's values.public static com.forgerock.opendj.cli.ArgumentException unableToSetNamingProperty(AbstractManagedObjectDefinition<?,?> d, PropertyDefinition<?> pd)
d
- The managed object definition.pd
- The naming property definition.public static com.forgerock.opendj.cli.ArgumentException unknownCategory(String categoryName)
categoryName
- The unrecognized component category.public static com.forgerock.opendj.cli.ArgumentException unknownProperty(AbstractManagedObjectDefinition<?,?> d, String name)
d
- The managed object definition.name
- The unrecognized property name.public static com.forgerock.opendj.cli.ArgumentException unknownProperty(String name)
name
- The unrecognized property name.public static com.forgerock.opendj.cli.ArgumentException unknownSubType(RelationDefinition<?,?> r, String typeName, String typeUsage)
r
- The relation definition.typeName
- The unrecognized property sub-type.typeUsage
- A usage string describing the allowed sub-types.public static com.forgerock.opendj.cli.ArgumentException unknownTypeForCategory(String typeName, String categoryName)
categoryName
- The component category.typeName
- The unrecognized component type.public static com.forgerock.opendj.cli.ArgumentException unknownValueForMultiValuedProperty(String value, String propertyName)
value
- The property value.propertyName
- The property name.public static com.forgerock.opendj.cli.ArgumentException unknownValueForChildComponent(String componentName)
componentName
- The component name.public static com.forgerock.opendj.cli.ClientException wrongManagedObjectType(RelationDefinition<?,?> r, ManagedObjectDefinition<?,?> d, String subcommandName)
r
- The relation definition.d
- The definition of the managed object that was retrieved.subcommandName
- the sub-command name.Copyright 2010-2017 ForgeRock AS.