com.goldencode.p2j.main

Class ClientsToPortsGenerator

java.lang.Object

com.goldencode.p2j.main.ClientsToPortsGenerator

public class ClientsToPortsGenerator
extends java.lang.Object

Creates mapping clients to their ports and added corresponding settings under the webClient parent node. TODO refactor this with the other tool: SSLCertGenUtil

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ClientsToPortsGenerator.HostsFileParser Defines the hosts file parser.

Field Summary

Fields

Modifier and Type	Field and Description
private BootstrapConfig	cfg Configuration used to initialize the directory.
private DirectoryService	ds Instance to access the directory.
private static java.lang.String	OUTPUT_FILE The generated mapping clients to their ports will be saved into this file
private java.io.BufferedReader	reader Read data from the standard input.
private static java.lang.String[]	YES_NO Valid entries for yes/no options.

Constructor Summary

Constructors

Constructor and Description
ClientsToPortsGenerator(BootstrapConfig config) Create a new utility.

Method Summary

Modifier and Type	Method and Description
private void	addNode(java.lang.String nodeId, java.lang.String cls, Attribute[] attrs) Add a new node to the directory, having the specified class and attributes.
private void	addNode(java.lang.String nodeId, java.lang.String cls, java.lang.Object value) Add a new node to the directory, having the specified class and a single attribute with the same class and specified value.
static boolean	appendHost(java.lang.String filePath, java.lang.String hostNameOrIpAddress, java.lang.Integer value) Appends new host and its value to the hosts file.
private void	closeBatch(java.lang.String node) Close a batch editing session.
private void	deleteNode(java.lang.String nodeId) Delete the specified node and all of its children.
private int	enterPortsRangeTo(int from)
void	generate(java.lang.String hostsFilePath) Main method to generate mapping clients to their ports.
static java.lang.String	getPortName(java.lang.String prefix, int from, java.lang.Integer hostIndex, int port) Represents a well-defined mapping from host indices to their names.
static void	main(java.lang.String[] args) Command line driver.
private void	openBatch(java.lang.String node) Open a batch editing session for the specified node.
static java.util.Map<java.lang.String,java.lang.Integer>	readHostsFile(java.lang.String filePath) Reads the given hosts file and returns the hosts map.
private java.lang.String	readLine(java.lang.String txt) Read a line of text using the created reader.
private java.lang.String	readOption(java.lang.String msg, java.lang.String[] valid) Ask the user to enter one of the specified valid options, using the given message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OUTPUT_FILE

private static final java.lang.String OUTPUT_FILE

The generated mapping clients to their ports will be saved into this file

See Also:

Constant Field Values

YES_NO

private static final java.lang.String[] YES_NO

Valid entries for yes/no options.

reader

private final java.io.BufferedReader reader

Read data from the standard input.

cfg

private final BootstrapConfig cfg

Configuration used to initialize the directory.

ds

private DirectoryService ds

Instance to access the directory.

Constructor Detail

ClientsToPortsGenerator

public ClientsToPortsGenerator(BootstrapConfig config)

Create a new utility.

Parameters:

config - Configuration for accessing the directory.

Method Detail

generate

public void generate(java.lang.String hostsFilePath)
              throws ConfigurationException,
                     java.io.IOException

Main method to generate mapping clients to their ports. Added corresponding settings under the webClient parent node in the directory.

Parameters:

hostsFilePath - The string representing the file path to the hosts file

Throws:

ConfigurationException - In case the directory service could not be initialized.

java.io.IOException - If standard input can not be accessed.

getPortName

public static java.lang.String getPortName(java.lang.String prefix,
                                           int from,
                                           java.lang.Integer hostIndex,
                                           int port)

Represents a well-defined mapping from host indices to their names.

Parameters:

prefix - The client prefix

from - The beginning value of the given port range

hostIndex - The host index

port - The port number

Returns:

The port name

enterPortsRangeTo

private int enterPortsRangeTo(int from)
                       throws java.io.IOException

Throws:

java.io.IOException

deleteNode

private void deleteNode(java.lang.String nodeId)

Delete the specified node and all of its children.

Parameters:

nodeId - The node ID.

Throws:

java.lang.RuntimeException - If the node or one of its children could not be deleted.

addNode

private void addNode(java.lang.String nodeId,
                     java.lang.String cls,
                     java.lang.Object value)

Add a new node to the directory, having the specified class and a single attribute with the same class and specified value.

Parameters:

nodeId - The node ID.

cls - The node's and attribute's class.

value - The attribute's value.

Throws:

java.lang.RuntimeException - If the node could not be added.

addNode

private void addNode(java.lang.String nodeId,
                     java.lang.String cls,
                     Attribute[] attrs)

Add a new node to the directory, having the specified class and attributes.

Parameters:

nodeId - The node ID.

cls - The node's class.

attrs - The node's attributes.

Throws:

java.lang.RuntimeException - If the node could not be added.

openBatch

private void openBatch(java.lang.String node)

Open a batch editing session for the specified node.

Parameters:

node - The node ID.

Throws:

java.lang.RuntimeException - If the batch editing session could not be opened.

closeBatch

private void closeBatch(java.lang.String node)

Close a batch editing session.

Parameters:

node - The node ID.

Throws:

java.lang.RuntimeException - If the batch editing session could not be closed.

readLine

private java.lang.String readLine(java.lang.String txt)
                           throws java.io.IOException

Read a line of text using the created reader.

Parameters:

txt - Description to be written to standard output.

Returns:

The line of text from standard input.

Throws:

java.io.IOException - If data could not be read.

readOption

private java.lang.String readOption(java.lang.String msg,
                                    java.lang.String[] valid)
                             throws java.io.IOException

Ask the user to enter one of the specified valid options, using the given message.

Parameters:

msg - The message shown to the user.

valid - An array of valid options.

Throws:

java.io.IOException

main

public static void main(java.lang.String[] args)
                 throws ConfigurationException,
                        java.io.IOException

Command line driver.

Parameters:

args - Application command line parameters. File name is the only one expected.

Throws:

ConfigurationException - In case the directory service could not be initialized.

java.io.IOException - If standard input can not be accessed.

readHostsFile

public static java.util.Map<java.lang.String,java.lang.Integer> readHostsFile(java.lang.String filePath)
                                                                       throws java.io.IOException

Reads the given hosts file and returns the hosts map.

Parameters:

filePath - The path to the hosts file

Returns:

The hosts map that is filled with new data.

Throws:

java.io.IOException - Iff create, write or read operations applied to the target file is failed

appendHost

public static boolean appendHost(java.lang.String filePath,
                                 java.lang.String hostNameOrIpAddress,
                                 java.lang.Integer value)

Appends new host and its value to the hosts file.

Parameters:

filePath - The path to the hosts file

hostNameOrIpAddress - The new host address

value - The new host value

Returns:

True iff the host address and its value has been appended successfully, otherwise returns false.