Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
* Copyright (C) 2014-2017 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.helger.masterdata.swift;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
import java.util.Locale;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.helger.commons.CGlobal;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.impl.CommonsHashMap;
import com.helger.commons.collection.impl.ICommonsMap;
import com.helger.commons.collection.impl.ICommonsSet;
import com.helger.commons.datetime.PDTFromString;
import com.helger.commons.exception.InitializationException;
import com.helger.commons.io.resource.ClassPathResource;
import com.helger.commons.locale.country.CountryCache;
import com.helger.commons.regex.RegExHelper;
import com.helger.commons.string.StringHelper;
import com.helger.commons.string.StringParser;
import com.helger.xml.microdom.IMicroDocument;
import com.helger.xml.microdom.IMicroElement;
import com.helger.xml.microdom.serialize.MicroReader;
/**
* Contains the IBAN manager.
* All banks in Europe (except for those in the CIS) provide an IBAN identifier
* for their accounts as well as nationally recognized identifiers. In addition,
* Israel, Tunisia, Mauritius, Turkey, and Saudi Arabia also provide IBAN format
* account identifiers.
* Banks in the British dependencies (except Gibraltar and the Crown
* Dependencies) do not use the IBAN format, but this may be due to internal
* banking regulatory issues. Banks in the Dutch West Indies don't use the IBAN
* format either. Some banks outside Europe may not recognize IBAN, though as
* time passes this is expected to diminish. Non-European banks typically accept
* IBANs as bank account numbers for accounts in Europe, although they might not
* treat IBANs differently to the way they treat other foreign bank account
* numbers. In particular, they might choose not to check that the IBAN is valid
* prior to sending the payment.
* In the absence of an IBAN it remains necessary to use the current ISO 9362
* Bank Identifier Code system (BIC or SWIFT code) in conjunction with the BBAN.
*
* Banks in the United States do not provide IBAN format account numbers. Any
* adoption of the IBAN standard by U.S. banks would likely be initiated by ANSI
* ASC X9, the U.S. financial services standards development organization but to
* date it has not done so. Hence payments to U.S. bank accounts from outside
* the U.S. are prone to errors of routing.
* Banks in Australia and New Zealand have not adopted IBAN, and tend to use
* Bank State Branch codes for domestic transfers and SWIFT for international.
*
* Source: http://en.wikipedia.org/wiki/International_Bank_Account_Number
*
* @author Philip Helger
*/
public final class IBANManager
{
private static final String ELEMENT_COUNTRY = "country";
private static final String ATTR_VALIDFROM = "validfrom";
private static final String ATTR_VALIDUNTIL = "validuntil";
private static final String ATTR_LEN = "len";
private static final String ATTR_CHECKDIGITS = "checkdigits";
private static final String ATTR_LAYOUT = "layout";
private static final int ILLEGAL_CHECKSUM = CGlobal.ILLEGAL_UINT;
private static final Logger s_aLogger = LoggerFactory.getLogger (IBANManager.class);
/** Maps country code to IBAn country data */
private static final ICommonsMap s_aIBANData = new CommonsHashMap <> ();
static
{
_readIBANDataFromXML ();
}
private IBANManager ()
{}
/**
* Read all IBAN country data from a file.
*/
private static void _readIBANDataFromXML ()
{
final IMicroDocument aDoc = MicroReader.readMicroXML (new ClassPathResource ("codelists/iban-country-data.xml"));
if (aDoc == null)
throw new InitializationException ("Failed to read IBAN country data [1]");
if (aDoc.getDocumentElement () == null)
throw new InitializationException ("Failed to read IBAN country data [2]");
final DateTimeFormatter aDTPattern = DateTimeFormatter.ISO_DATE;
for (final IMicroElement eCountry : aDoc.getDocumentElement ().getAllChildElements (ELEMENT_COUNTRY))
{
// get descriptive string
final String sDesc = eCountry.getTextContent ();
final String sCountryCode = sDesc.substring (0, 2);
if (CountryCache.getInstance ().getCountry (sCountryCode) == null)
s_aLogger.warn ("IBAN country data: no such country code '" + sCountryCode + "' - be careful");
LocalDate aValidFrom = null;
if (eCountry.hasAttribute (ATTR_VALIDFROM))
{
// Constant format, conforming to XML date
aValidFrom = PDTFromString.getLocalDateFromString (eCountry.getAttributeValue (ATTR_VALIDFROM), aDTPattern);
}
LocalDate aValidTo = null;
if (eCountry.hasAttribute (ATTR_VALIDUNTIL))
{
// Constant format, conforming to XML date
aValidTo = PDTFromString.getLocalDateFromString (eCountry.getAttributeValue (ATTR_VALIDUNTIL), aDTPattern);
}
final String sLayout = eCountry.getAttributeValue (ATTR_LAYOUT);
final String sCheckDigits = eCountry.getAttributeValue (ATTR_CHECKDIGITS);
// get expected length
final String sLen = eCountry.getAttributeValue (ATTR_LEN);
final int nExpectedLength = StringParser.parseInt (sLen, CGlobal.ILLEGAL_UINT);
if (nExpectedLength == CGlobal.ILLEGAL_UINT)
throw new InitializationException ("Failed to convert length '" + sLen + "' to int!");
if (s_aIBANData.containsKey (sCountryCode))
throw new IllegalArgumentException ("Country " + sCountryCode + " is already contained!");
s_aIBANData.put (sCountryCode,
IBANCountryData.createFromString (sCountryCode,
nExpectedLength,
sLayout,
sCheckDigits,
aValidFrom,
aValidTo,
sDesc));
}
}
/**
* Get the country data for the given country code.
*
* @param sCountryCode
* The country code to use. May not be null and needs to
* have exactly 2 characters to work.
* @return null if the passed country has no IBAN support.
*/
@Nullable
public static IBANCountryData getCountryData (@Nonnull final String sCountryCode)
{
ValueEnforcer.notNull (sCountryCode, "CountryCode");
return s_aIBANData.get (sCountryCode.toUpperCase (Locale.US));
}
/**
* @return An unmodifiable, non-null set of all countries for
* which IBAN information is present.
*/
@Nonnull
@ReturnsMutableCopy
public static ICommonsSet getAllSupportedCountries ()
{
return s_aIBANData.copyOfKeySet ();
}
private static int _calculateChecksum (@Nonnull final String sIBAN)
{
final String sCalcBase = sIBAN.substring (4) + sIBAN.substring (0, 4);
int nChecksum = 0;
final int nLength = sCalcBase.length ();
for (int nIndex = 0; nIndex < nLength; nIndex++)
{
final char c = sCalcBase.charAt (nIndex);
int nCurChecksumValue;
if (c >= '0' && c <= '9')
nCurChecksumValue = c - '0';
else
if (c >= 'A' && c <= 'Z')
nCurChecksumValue = c - '7';
else
return ILLEGAL_CHECKSUM;
if (nCurChecksumValue > 9)
nChecksum = (100 * nChecksum + nCurChecksumValue) % 97;
else
nChecksum = (10 * nChecksum + nCurChecksumValue) % 97;
}
return nChecksum;
}
private static boolean _isValidChecksumChar (final char c)
{
return c >= '0' && c <= '9';
}
/**
* Make an IBAN that can be parsed. It is converted to upper case and all
* non-alphanumeric characters are removed.
*
* @param sIBAN
* The IBAN to be unified.
* @return The unified string or null if this is no IBAN at all.
*/
@Nullable
public static String unifyIBAN (@Nullable final String sIBAN)
{
if (sIBAN == null)
return null;
// to uppercase
String sRealIBAN = sIBAN.toUpperCase (Locale.US);
// kick all non-IBAN chars
sRealIBAN = RegExHelper.stringReplacePattern ("[^0-9A-Z]", sRealIBAN, "");
if (sRealIBAN.length () < 4)
return null;
return sRealIBAN;
}
/**
* Check if the passed IBAN is valid and the country is supported!
*
* @param sIBAN
* The IBAN number string to check.
* @return true if the IBAN is valid and supported.
*/
public static boolean isValidIBAN (@Nullable final String sIBAN)
{
return isValidIBAN (sIBAN, false);
}
/**
* Check if the passed IBAN is valid and the country is supported!
*
* @param sIBAN
* The IBAN number string to check.
* @param bReturnCodeIfNoCountryData
* The return value if no country data is present for the specified
* IBAN.
* @return true if the IBAN is valid and supported.
*/
public static boolean isValidIBAN (@Nullable final String sIBAN, final boolean bReturnCodeIfNoCountryData)
{
// kick all non-IBAN chars
final String sRealIBAN = unifyIBAN (sIBAN);
if (sRealIBAN == null)
return false;
// is the country supported?
final IBANCountryData aData = s_aIBANData.get (sRealIBAN.substring (0, 2));
if (aData == null)
return bReturnCodeIfNoCountryData;
// Does the length match the expected length?
if (aData.getExpectedLength () != sRealIBAN.length ())
return false;
// Are the checksum characters valid?
if (!_isValidChecksumChar (sRealIBAN.charAt (2)) || !_isValidChecksumChar (sRealIBAN.charAt (3)))
return false;
// Is existing checksum valid?
if (_calculateChecksum (sRealIBAN) != 1)
return false;
// Perform pattern check
if (!aData.matchesPattern (sRealIBAN))
return false;
return true;
}
public static int createChecksumOfNewIBAN (@Nonnull final String sCountryCode, @Nonnull final String sBBAN)
{
ValueEnforcer.notNull (sCountryCode, "CountryCode");
if (sCountryCode.length () != 2)
throw new IllegalArgumentException ("Country code does not have exactly 2 characters!");
ValueEnforcer.notNull (sBBAN, "BBAN");
// unify aggregated IBAN
final String sIBAN = unifyIBAN (sCountryCode + "00" + sBBAN);
if (sIBAN == null)
throw new IllegalArgumentException ("The passed data does not resemble an IBAN!");
// calculate the new checksum
final int nChecksum = _calculateChecksum (sIBAN);
if (nChecksum == ILLEGAL_CHECKSUM)
throw new IllegalArgumentException ("The passed data does not resemble an IBAN!");
return 98 - (((nChecksum - 1) % 97) + 1);
}
@Nonnull
public static String createIBANWithValidChecksum (@Nonnull final String sCountry, @Nonnull final String sBBAN)
{
// create the checksum
final int nChecksum = createChecksumOfNewIBAN (sCountry, sBBAN);
// convert to unified IBAN
return unifyIBAN (sCountry + StringHelper.getLeadingZero (nChecksum, 2) + sBBAN);
}
@Nullable
public static String getFormattedIBAN (@Nullable final String sIBAN)
{
// Group into pieces of 4 digits and separate with a space
return getFormattedIBAN (sIBAN, 4, " ");
}
@Nullable
public static String getFormattedIBAN (@Nullable final String sIBAN,
@Nonnegative final int nGroupSize,
@Nonnull @Nonempty final String sDelimiter)
{
ValueEnforcer.isGT0 (nGroupSize, "GroupSize");
ValueEnforcer.notEmpty (sDelimiter, "Delimiter");
if (StringHelper.hasNoText (sIBAN))
return sIBAN;
final StringBuilder aSB = new StringBuilder ();
String sRest = unifyIBAN (sIBAN);
while (sRest.length () >= nGroupSize)
{
aSB.append (sRest, 0, nGroupSize);
sRest = sRest.substring (nGroupSize);
if (sRest.length () > 0)
aSB.append (sDelimiter);
}
aSB.append (sRest);
return aSB.toString ();
}
}
