001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *  
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *  
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License. 
018 *  
019 */
020package org.apache.directory.api.ldap.model.schema.syntaxCheckers;
021
022
023import org.apache.directory.api.ldap.model.constants.SchemaConstants;
024import org.apache.directory.api.ldap.model.schema.SyntaxChecker;
025import org.apache.directory.api.util.Strings;
026import org.slf4j.Logger;
027import org.slf4j.LoggerFactory;
028
029
030/**
031 * A SyntaxChecker which verifies that a value is a PostalAddress according to 
032 * RFC 4517 :
033 * 
034 * <postal-address> = <dstring> <dstring-list>
035 * <dstring-list> = "$" <dstring> <dstring-list> | e
036 * 
037 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
038 */
039@SuppressWarnings("serial")
040public class PostalAddressSyntaxChecker extends SyntaxChecker
041{
042    /** A logger for this class */
043    private static final Logger LOG = LoggerFactory.getLogger( PostalAddressSyntaxChecker.class );
044
045
046    /**
047     * Creates a new instance of PostalAddressSyntaxChecker.
048     */
049    public PostalAddressSyntaxChecker()
050    {
051        super( SchemaConstants.POSTAL_ADDRESS_SYNTAX );
052    }
053
054
055    /**
056     * {@inheritDoc}
057     */
058    public boolean isValidSyntax( Object value )
059    {
060        String strValue = null;
061
062        if ( value == null )
063        {
064            LOG.debug( "Syntax invalid for 'null'" );
065            return false;
066        }
067
068        if ( value instanceof String )
069        {
070            strValue = ( String ) value;
071        }
072        else if ( value instanceof byte[] )
073        {
074            strValue = Strings.utf8ToString( ( byte[] ) value );
075        }
076        else
077        {
078            strValue = value.toString();
079        }
080
081        if ( strValue.length() == 0 )
082        {
083            LOG.debug( "Syntax invalid for '{}'", value );
084            return false;
085        }
086
087        // Search for the '$' separator
088        int dollar = strValue.indexOf( '$' );
089
090        if ( dollar == -1 )
091        {
092            // No '$' => only a dstring
093            LOG.debug( "Syntax valid for '{}'", value );
094            return true;
095        }
096
097        int pos = 0;
098        do
099        {
100            // check that the element between each '$' is not empty
101            String address = strValue.substring( pos, dollar );
102
103            if ( Strings.isEmpty( address ) )
104            {
105                LOG.debug( "Syntax invalid for '{}'", value );
106                return false;
107            }
108
109            pos = dollar + 1;
110
111            if ( pos == strValue.length() )
112            {
113                // we should not have a '$' at the end
114                LOG.debug( "Syntax invalid for '{}'", value );
115                return false;
116            }
117
118            dollar = strValue.indexOf( '$', pos );
119        }
120        while ( dollar > -1 );
121
122        return true;
123    }
124}