java.lang.Object
- org.wildfly.security.tool.Command
- - org.wildfly.security.tool.FileSystemEncryptRealmCommand

```
class FileSystemEncryptRealmCommand
extends Command
```
Elytron-Tool command to convert un-encrypted FileSystemRealms into an encrypted realm with the use of a SecretKey. Also, optionally provides a WildFly CLI script to register the FileSystemRealm and corresponding security-domain in WildFly.

Author:

Ashpan Raskar

Nested Class Summary

Nested Classes
Modifier and Type Class Description

private static class FileSystemEncryptRealmCommand.Descriptor

Field Summary

Fields
Modifier and Type	Field	Description
`private static String`	`BULK_CONVERT_PARAM`
`private org.apache.commons.cli.CommandLine`	`cmdLine`
`private static String`	`CREATE_CREDENTIAL_STORE_PARAM`
`private static String`	`CREDENTIAL_STORE_LOCATION_PARAM`
`private static String`	`DEBUG_PARAM`
`private static String`	`DEFAULT_FILESYSTEM_REALM_NAME`
`private List<FileSystemEncryptRealmCommand.Descriptor>`	`descriptors`
`private static String`	`DIRECTORY_ARG`
`static Supplier<Provider[]>`	`ELYTRON_PASSWORD_PROVIDERS`
`private static String`	`ENCODED_PARAM`
`private static String`	`FILE_ARG`
`(package private) static String`	`FILE_SYSTEM_ENCRYPT_COMMAND`
`(package private) static int`	`GENERAL_CONFIGURATION_WARNING`
`private static String`	`HASH_ENCODING_PARAM`
`private static String`	`HELP_PARAM`
`private static String`	`INPUT_REALM_LOCATION_PARAM`
`private static String`	`LEVELS_PARAM`
`private static String`	`NAME_ARG`
`private org.apache.commons.cli.Options`	`options`
`private static String`	`OUTPUT_REALM_LOCATION_PARAM`
`private List<String>`	`PARAMS_LIST`
`private org.apache.commons.cli.CommandLineParser`	`parser`
`private static String`	`POPULATE_SECRET_KEY_PARAM`
`private static String`	`REALM_NAME_PARAM`
`private static String`	`SECRET_KEY_ALIAS_PARAM`
`private static String`	`SILENT_PARAM`
`private boolean`	`silentMode`
`private static String`	`SUMMARY_PARAM`
`(package private) static int`	`SUMMARY_WIDTH`
`private boolean`	`summaryMode`
`private StringBuilder`	`summaryString`
`private boolean`	`warningOccurred`

Fields inherited from class org.wildfly.security.tool.Command
GENERAL_CONFIGURATION_ERROR, INPUT_DATA_NOT_CONFIRMED, WIDTH

Constructor Summary

Constructors
Constructor Description

FileSystemEncryptRealmCommand()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private boolean`	`checkDescriptorFields(FileSystemEncryptRealmCommand.Descriptor descriptor)`
`private void`	`copyAddResetDescriptor(FileSystemEncryptRealmCommand.Descriptor original)`	Copies a Descriptor into a temporary one for it can be cloned into the list of descriptors
`private void`	`createFileSystemRealm()`	Handles creating the Elytron filesystem-realm from the descriptor array
`private void`	`createWildFlyScript()`	Creates the script/commands the user must run for Elytron to recognize and use the new filesystem-realm
`private void`	`errorHandler(Exception e)`	Determines if a summary needs to be printed and prints summary after an error is thrown
`void`	`execute(String[] args)`
`private void`	`findMissingRequiredValuesAndSetValues(int count, FileSystemEncryptRealmCommand.Descriptor descriptor)`	Determines if the current descriptor block is missing any required values and then if it is, prints out a warning message and sets that required value and the optional values to null
`private String`	`getDescriptorParam(String param, FileSystemEncryptRealmCommand.Descriptor descriptor)`	Returns the value for a given param in a Descriptor object
`void`	`help()`	Displays the help for the command
`private void`	`parseDescriptorFile(String file)`	Handles input being given as a descriptor file
`private void`	`printDescriptorBlocks(int count)`	Prints out information found in a descriptor file for summary mode
`private void`	`warningHandler(String warning)`	Prints out a warning message if silentMode is not enabled and adds the warning to the summary if summaryMode is enabled

Methods inherited from class org.wildfly.security.tool.Command
aliases, getProvidersSupplier, getStatus, getToolCommand, isAlias, isEnableDebug, isWindows, printDuplicatesWarning, printDuplicatesWarning, prompt, setEnableDebug, setStatus, setToolCommand

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - GENERAL_CONFIGURATION_WARNING
```
static final int GENERAL_CONFIGURATION_WARNING
```
    See Also:
    
    Constant Field Values
  - FILE_SYSTEM_ENCRYPT_COMMAND
```
static final String FILE_SYSTEM_ENCRYPT_COMMAND
```
    See Also:
    
    Constant Field Values
  - SUMMARY_WIDTH
```
static final int SUMMARY_WIDTH
```
    See Also:
    
    Constant Field Values
  - HELP_PARAM
```
private static final String HELP_PARAM
```
    See Also:
    
    Constant Field Values
  - DEBUG_PARAM
```
private static final String DEBUG_PARAM
```
    See Also:
    
    Constant Field Values
  - SILENT_PARAM
```
private static final String SILENT_PARAM
```
    See Also:
    
    Constant Field Values
  - SUMMARY_PARAM
```
private static final String SUMMARY_PARAM
```
    See Also:
    
    Constant Field Values
  - INPUT_REALM_LOCATION_PARAM
```
private static final String INPUT_REALM_LOCATION_PARAM
```
    See Also:
    
    Constant Field Values
  - REALM_NAME_PARAM
```
private static final String REALM_NAME_PARAM
```
    See Also:
    
    Constant Field Values
  - OUTPUT_REALM_LOCATION_PARAM
```
private static final String OUTPUT_REALM_LOCATION_PARAM
```
    See Also:
    
    Constant Field Values
  - CREDENTIAL_STORE_LOCATION_PARAM
```
private static final String CREDENTIAL_STORE_LOCATION_PARAM
```
    See Also:
    
    Constant Field Values
  - CREATE_CREDENTIAL_STORE_PARAM
```
private static final String CREATE_CREDENTIAL_STORE_PARAM
```
    See Also:
    
    Constant Field Values
  - SECRET_KEY_ALIAS_PARAM
```
private static final String SECRET_KEY_ALIAS_PARAM
```
    See Also:
    
    Constant Field Values
  - HASH_ENCODING_PARAM
```
private static final String HASH_ENCODING_PARAM
```
    See Also:
    
    Constant Field Values
  - ENCODED_PARAM
```
private static final String ENCODED_PARAM
```
    See Also:
    
    Constant Field Values
  - LEVELS_PARAM
```
private static final String LEVELS_PARAM
```
    See Also:
    
    Constant Field Values
  - POPULATE_SECRET_KEY_PARAM
```
private static final String POPULATE_SECRET_KEY_PARAM
```
    See Also:
    
    Constant Field Values
  - BULK_CONVERT_PARAM
```
private static final String BULK_CONVERT_PARAM
```
    See Also:
    
    Constant Field Values
  - FILE_ARG
```
private static final String FILE_ARG
```
    See Also:
    
    Constant Field Values
  - DIRECTORY_ARG
```
private static final String DIRECTORY_ARG
```
    See Also:
    
    Constant Field Values
  - NAME_ARG
```
private static final String NAME_ARG
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FILESYSTEM_REALM_NAME
```
private static final String DEFAULT_FILESYSTEM_REALM_NAME
```
    See Also:
    
    Constant Field Values
  - ELYTRON_PASSWORD_PROVIDERS
```
public static Supplier<Provider[]> ELYTRON_PASSWORD_PROVIDERS
```
  - descriptors
```
private final List<FileSystemEncryptRealmCommand.Descriptor> descriptors
```
  - PARAMS_LIST
```
private final List<String> PARAMS_LIST
```
  - options
```
private final org.apache.commons.cli.Options options
```
  - parser
```
private final org.apache.commons.cli.CommandLineParser parser
```
  - cmdLine
```
private org.apache.commons.cli.CommandLine cmdLine
```
  - silentMode
```
private boolean silentMode
```
  - summaryMode
```
private boolean summaryMode
```
  - summaryString
```
private StringBuilder summaryString
```
  - warningOccurred
```
private boolean warningOccurred
```
- Constructor Detail
  - FileSystemEncryptRealmCommand
```
FileSystemEncryptRealmCommand()
```
- Method Detail
  - execute
```
public void execute(String[] args)
             throws Exception
```
    Specified by:
    
    execute in class Command
    
    Throws:
    
    Exception
  - help
```
public void help()
```
    Displays the help for the command
    
    Overrides:
    
    help in class Command
  - warningHandler
```
private void warningHandler(String warning)
```
    Prints out a warning message if silentMode is not enabled and adds the warning to the summary if summaryMode is enabled
    
    Parameters:
    
    warning - The warning to be shown
  - errorHandler
```
private void errorHandler(Exception e)
                   throws Exception
```
    Determines if a summary needs to be printed and prints summary after an error is thrown
    
    Parameters:
    
    e - The exception thrown during execution
    
    Throws:
    
    Exception - The exception to be handled by Elytron Tool
  - printDescriptorBlocks
```
private void printDescriptorBlocks(int count)
```
    Prints out information found in a descriptor file for summary mode
    
    Parameters:
    
    count - The amount of descriptor blocks in the file
  - getDescriptorParam
```
private String getDescriptorParam(String param,
                                  FileSystemEncryptRealmCommand.Descriptor descriptor)
```
    Returns the value for a given param in a Descriptor object
    
    Parameters:
    
    param - The parameter to be obtained from the Descriptor object
    
    descriptor - The Descriptor object to be used
    
    Returns:
    
    The value of the given parameter
  - parseDescriptorFile
```
private void parseDescriptorFile(String file)
                          throws Exception
```
    Handles input being given as a descriptor file
    
    Throws:
    
    Exception - Exception to be handled by Elytron Tool
  - copyAddResetDescriptor
```
private void copyAddResetDescriptor(FileSystemEncryptRealmCommand.Descriptor original)
```
    Copies a Descriptor into a temporary one for it can be cloned into the list of descriptors
    
    Parameters:
    
    original - The original descriptor that is continually modified
  - findMissingRequiredValuesAndSetValues
```
private void findMissingRequiredValuesAndSetValues(int count,
                                                   FileSystemEncryptRealmCommand.Descriptor descriptor)
```
    Determines if the current descriptor block is missing any required values and then if it is, prints out a warning message and sets that required value and the optional values to null
    
    Parameters:
    
    count - The index of the current descriptor block
  - createFileSystemRealm
```
private void createFileSystemRealm()
                            throws Exception
```
    Handles creating the Elytron filesystem-realm from the descriptor array
    
    Throws:
    
    Exception - Exception to be handled by Elytron Tool
  - createWildFlyScript
```
private void createWildFlyScript()
                          throws Exception
```
    Creates the script/commands the user must run for Elytron to recognize and use the new filesystem-realm
    
    Throws:
    
    Exception
  - checkDescriptorFields
```
private boolean checkDescriptorFields(FileSystemEncryptRealmCommand.Descriptor descriptor)
```

Class FileSystemEncryptRealmCommand

Nested Class Summary

Field Summary

Fields inherited from class org.wildfly.security.tool.Command

Constructor Summary

Method Summary

Methods inherited from class org.wildfly.security.tool.Command

Methods inherited from class java.lang.Object

Field Detail

GENERAL_CONFIGURATION_WARNING

FILE_SYSTEM_ENCRYPT_COMMAND

SUMMARY_WIDTH

HELP_PARAM

DEBUG_PARAM

SILENT_PARAM

SUMMARY_PARAM

INPUT_REALM_LOCATION_PARAM

REALM_NAME_PARAM

OUTPUT_REALM_LOCATION_PARAM

CREDENTIAL_STORE_LOCATION_PARAM

CREATE_CREDENTIAL_STORE_PARAM

SECRET_KEY_ALIAS_PARAM

HASH_ENCODING_PARAM

ENCODED_PARAM

LEVELS_PARAM

POPULATE_SECRET_KEY_PARAM

BULK_CONVERT_PARAM

FILE_ARG

DIRECTORY_ARG

NAME_ARG

DEFAULT_FILESYSTEM_REALM_NAME

ELYTRON_PASSWORD_PROVIDERS

descriptors

PARAMS_LIST

options

parser

cmdLine

silentMode

summaryMode

summaryString

warningOccurred

Constructor Detail

FileSystemEncryptRealmCommand

Method Detail

execute

help

warningHandler

errorHandler

printDescriptorBlocks

getDescriptorParam

parseDescriptorFile

copyAddResetDescriptor

findMissingRequiredValuesAndSetValues

createFileSystemRealm

createWildFlyScript

checkDescriptorFields