IntegerStartupParameter.java
/*
** Module : IntegerStartupParameter.java
** Abstract : Integer startup parameter class
**
** Copyright (c) 2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ----------------------------------Description---------------------------------
** 001 TT 20230915 Created initial version.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.startup.parameters;
import com.goldencode.p2j.cfg.*;
import com.goldencode.p2j.directory.*;
import com.goldencode.p2j.main.*;
import com.goldencode.p2j.util.*;
import com.goldencode.util.*;
import java.io.*;
import static com.goldencode.p2j.util.ErrorManager.*;
import static com.goldencode.p2j.util.Utils.DirScope.*;
/**
* This class encapsulates the functionality for {@link Integer} startup parameters.
*/
public final class IntegerStartupParameter
extends StartupParameter<Integer>
{
/**
* This is the default constructor which calls the {@link StartupParameter} constructor.
*
* @param name is the parameter name used by FWD.
* @param originalName is the original name used by OE.
*/
public IntegerStartupParameter(String name, String originalName)
{
super(name, originalName);
}
/**
* This is the default constructor which calls the {@link StartupParameter} constructor.
*
* @param prefix is the parameter name prefix used by FWD.
* @param name is the parameter name used by FWD.
* @param originalName is the original name used by OE.
*/
public IntegerStartupParameter(String prefix, String name, String originalName)
{
super(prefix, name, originalName);
}
/**
* Converts the parameter from string to integer and handles the relevant errors.
*
* @param parameter is the string parameter value.
* @return the integer value.
*/
private static Integer getIntegerParameter(String parameter) {
if (parameter == null) return null;
String param = parameter.trim();
if (!parameter.matches("-?\\d+(\\.\\d+)?"))
{
String text = "The " + param + " parameter requires a numeric argument.";
PostInitErrorManager.addError(() -> recordOrThrowError(11996, text, false));
return null;
}
if (parameter.length() > 10)
{
String text = "The " + parameter + " parameter has too many digits.";
PostInitErrorManager.addError(() -> recordOrThrowError(5049, text, false));
return null;
}
long parameterLong;
try
{
parameterLong = Long.parseLong(parameter);
}
catch (NumberFormatException e)
{
String text = "The " + parameter + " parameter requires a numeric argument.";
PostInitErrorManager.addError(() -> recordOrThrowError(11996, text, false));
return null;
}
if (parameterLong < 0 || parameterLong > Integer.MAX_VALUE)
{
String text = "The " + parameter + " parameter has too many digits.";
PostInitErrorManager.addError(() -> recordOrThrowError(5049, text, false));
return null;
}
return (int) parameterLong;
}
/**
* Initialize the parameter from the {@link DirectoryService}.
*/
@Override
public void initFromDirectory()
{
DirectoryService ds = DirectoryService.getInstance();
String nodeId = prefix == null ? name : prefix + "/" + name;
String parameter = Utils.getDirectoryNodeString(ds, nodeId, null, ACCOUNTS, null);
value = getIntegerParameter(parameter);
}
/**
* Initialize the parameter from the {@link BootstrapConfig}
*
* @param bootstrapConfig is the bootstrap configuration.
*/
@Override
public void initFromBootstrap(BootstrapConfig bootstrapConfig)
{
String parameter = bootstrapConfig.getString("client", "cmd-line-option", name, null);
value = getIntegerParameter(parameter);
}
/**
* Used for helping with {@link Externalizable#readExternal(ObjectInput)}
*
* @param in the stream to read data from in order to restore the object
* @exception IOException if I/O errors occur
*/
@Override
public void readExternal(ObjectInput in) throws IOException
{
value = NativeTypeSerializer.readInteger(in);
}
/**
* Used for helping with {@link Externalizable#writeExternal(ObjectOutput)}
*
* @param out the stream to write the object to
* @exception IOException Includes any I/O exceptions that may occur
*/
@Override
public void writeExternal(ObjectOutput out) throws IOException
{
NativeTypeSerializer.writeInteger(out, value);
}
}