| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you 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 |
| * |
| * https://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 org.apache.directory.api.ldap.model.schema.syntaxCheckers; |
| |
| |
| import java.util.HashSet; |
| import java.util.Set; |
| |
| import org.apache.directory.api.i18n.I18n; |
| import org.apache.directory.api.ldap.model.constants.SchemaConstants; |
| import org.apache.directory.api.ldap.model.schema.SyntaxChecker; |
| import org.apache.directory.api.util.Strings; |
| |
| |
| /** |
| * A SyntaxChecker which verifies that a value is a country according to RFC 4517. |
| * |
| * From RFC 4517 : |
| * |
| * <pre> |
| * A value of the Country String syntax is one of the two-character |
| * codes from ISO 3166 [ISO3166] for representing a country. |
| * </pre> |
| * |
| * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> |
| */ |
| @SuppressWarnings("serial") |
| public final class CountrySyntaxChecker extends SyntaxChecker |
| { |
| /** The ISO 3166 list of countries, as of 2006 */ |
| private static final String[] COUNTRY_ISO_3166 = |
| { |
| "AD", |
| "AE", |
| "AF", |
| "AG", |
| "AI", |
| "AL", |
| "AM", |
| "AN", |
| "AO", |
| "AQ", |
| "AR", |
| "AS", |
| "AT", |
| "AU", |
| "AW", |
| "AX", |
| "AZ", |
| "BA", |
| "BB", |
| "BD", |
| "BE", |
| "BF", |
| "BG", |
| "BH", |
| "BI", |
| "BJ", |
| "BM", |
| "BN", |
| "BO", |
| "BR", |
| "BS", |
| "BT", |
| "BV", |
| "BW", |
| "BY", |
| "BZ", |
| "CA", |
| "CC", |
| "CD", |
| "CF", |
| "CG", |
| "CH", |
| "CI", |
| "CK", |
| "CL", |
| "CM", |
| "CN", |
| "CO", |
| "CR", |
| "CU", |
| "CV", |
| "CX", |
| "CY", |
| "CZ", |
| "DE", |
| "DJ", |
| "DK", |
| "DM", |
| "DO", |
| "DZ", |
| "EC", |
| "EE", |
| "EG", |
| "EH", |
| "ER", |
| "ES", |
| "ET", |
| "FI", |
| "FJ", |
| "FK", |
| "FM", |
| "FO", |
| "FR", |
| "GA", |
| "GB", |
| "GD", |
| "GE", |
| "GG", |
| "GF", |
| "GH", |
| "GI", |
| "GL", |
| "GM", |
| "GN", |
| "GP", |
| "GQ", |
| "GR", |
| "GS", |
| "GT", |
| "GU", |
| "GW", |
| "GY", |
| "HK", |
| "HM", |
| "HN", |
| "HR", |
| "HT", |
| "HU", |
| "ID", |
| "IE", |
| "IL", |
| "IM", |
| "IN", |
| "IO", |
| "IQ", |
| "IR", |
| "IS", |
| "IT", |
| "JE", |
| "JM", |
| "JO", |
| "JP", |
| "KE", |
| "KG", |
| "KH", |
| "KI", |
| "KM", |
| "KN", |
| "KP", |
| "KR", |
| "KW", |
| "KY", |
| "KZ", |
| "LA", |
| "LB", |
| "LC", |
| "LI", |
| "LK", |
| "LR", |
| "LS", |
| "LT", |
| "LU", |
| "LV", |
| "LY", |
| "MA", |
| "MC", |
| "MD", |
| "ME", |
| "MG", |
| "MH", |
| "MK", |
| "ML", |
| "MM", |
| "MN", |
| "MO", |
| "MP", |
| "MQ", |
| "MR", |
| "MS", |
| "MT", |
| "MU", |
| "MV", |
| "MW", |
| "MX", |
| "MY", |
| "MZ", |
| "NA", |
| "NC", |
| "NE", |
| "NF", |
| "NG", |
| "NI", |
| "NL", |
| "NO", |
| "NP", |
| "NR", |
| "NU", |
| "NZ", |
| "OM", |
| "PA", |
| "PE", |
| "PF", |
| "PG", |
| "PH", |
| "PK", |
| "PL", |
| "PM", |
| "PN", |
| "PR", |
| "PS", |
| "PT", |
| "PW", |
| "PY", |
| "QA", |
| "RE", |
| "RO", |
| "RS", |
| "RU", |
| "RW", |
| "SA", |
| "SB", |
| "SC", |
| "SD", |
| "SE", |
| "SG", |
| "SH", |
| "SI", |
| "SJ", |
| "SK", |
| "SL", |
| "SM", |
| "SN", |
| "SO", |
| "SR", |
| "ST", |
| "SV", |
| "SY", |
| "SZ", |
| "TC", |
| "TD", |
| "TF", |
| "TG", |
| "TH", |
| "TJ", |
| "TK", |
| "TL", |
| "TM", |
| "TN", |
| "TO", |
| "TR", |
| "TT", |
| "TV", |
| "TW", |
| "TZ", |
| "UA", |
| "UG", |
| "UM", |
| "US", |
| "UY", |
| "UZ", |
| "VA", |
| "VC", |
| "VE", |
| "VG", |
| "VI", |
| "VN", |
| "VU", |
| "WF", |
| "WS", |
| "YE", |
| "YT", |
| "ZA", |
| "ZM", |
| "ZW" |
| }; |
| |
| /** The Set which contains the countries */ |
| private static final Set<String> COUNTRIES = new HashSet<>(); |
| |
| /** Initialization of the country set */ |
| static |
| { |
| for ( String country : COUNTRY_ISO_3166 ) |
| { |
| COUNTRIES.add( country ); |
| } |
| } |
| |
| /** |
| * A static instance of CountrySyntaxChecker |
| */ |
| public static final CountrySyntaxChecker INSTANCE = new CountrySyntaxChecker( SchemaConstants.COUNTRY_STRING_SYNTAX ); |
| |
| /** |
| * A static Builder for this class |
| */ |
| public static final class Builder extends SCBuilder<CountrySyntaxChecker> |
| { |
| /** |
| * The Builder constructor |
| */ |
| private Builder() |
| { |
| super( SchemaConstants.COUNTRY_STRING_SYNTAX ); |
| } |
| |
| |
| /** |
| * Create a new instance of CountrySyntaxChecker |
| * @return A new instance of CountrySyntaxChecker |
| */ |
| @Override |
| public CountrySyntaxChecker build() |
| { |
| return new CountrySyntaxChecker( oid ); |
| } |
| } |
| |
| |
| /** |
| * Creates a new instance of CountrySyntaxChecker. |
| * |
| * @param oid The OID to use for this SyntaxChecker |
| */ |
| private CountrySyntaxChecker( String oid ) |
| { |
| super( oid ); |
| } |
| |
| |
| /** |
| * @return An instance of the Builder for this class |
| */ |
| public static Builder builder() |
| { |
| return new Builder(); |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public boolean isValidSyntax( Object value ) |
| { |
| String strValue; |
| |
| if ( value == null ) |
| { |
| if ( LOG.isDebugEnabled() ) |
| { |
| LOG.debug( I18n.err( I18n.ERR_13210_SYNTAX_INVALID, "null" ) ); |
| } |
| |
| return false; |
| } |
| |
| if ( value instanceof String ) |
| { |
| strValue = ( String ) value; |
| } |
| else if ( value instanceof byte[] ) |
| { |
| strValue = Strings.utf8ToString( ( byte[] ) value ); |
| } |
| else |
| { |
| strValue = value.toString(); |
| } |
| |
| if ( strValue.length() == 0 ) |
| { |
| if ( LOG.isDebugEnabled() ) |
| { |
| LOG.debug( I18n.err( I18n.ERR_13210_SYNTAX_INVALID, value ) ); |
| } |
| |
| return false; |
| } |
| |
| boolean result = COUNTRIES.contains( Strings.toUpperCaseAscii( strValue ) ); |
| |
| if ( LOG.isDebugEnabled() ) |
| { |
| if ( result ) |
| { |
| LOG.debug( I18n.msg( I18n.MSG_13701_SYNTAX_VALID, value ) ); |
| } |
| else |
| { |
| LOG.debug( I18n.err( I18n.ERR_13210_SYNTAX_INVALID, value ) ); |
| } |
| } |
| |
| return result; |
| } |
| } |
