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.i18n.I18n;
024import org.apache.directory.api.ldap.model.constants.SchemaConstants;
025import org.apache.directory.api.ldap.model.schema.SyntaxChecker;
026import org.apache.directory.api.util.Strings;
027
028
029/**
030 * A SyntaxChecker which verifies that a value is a PostalAddress according to 
031 * RFC 4517 :
032 * <pre>
033 * &lt;postal-address&gt; = &lt;dstring&gt; &lt;dstring-list&gt;
034 * &lt;dstring-list&gt; = "$" &lt;dstring&gt; &lt;dstring-list&gt; | e
035 * </pre>
036 * 
037 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
038 */
039@SuppressWarnings("serial")
040public final class PostalAddressSyntaxChecker extends SyntaxChecker
041{
042    /**
043     * A static instance of PostalAddressSyntaxChecker
044     */
045    public static final PostalAddressSyntaxChecker INSTANCE = 
046        new PostalAddressSyntaxChecker( SchemaConstants.POSTAL_ADDRESS_SYNTAX );
047    
048    /**
049     * A static Builder for this class
050     */
051    public static final class Builder extends SCBuilder<PostalAddressSyntaxChecker>
052    {
053        /**
054         * The Builder constructor
055         */
056        private Builder()
057        {
058            super( SchemaConstants.POSTAL_ADDRESS_SYNTAX );
059        }
060        
061        
062        /**
063         * Create a new instance of PostalAddressSyntaxChecker
064         * @return A new instance of PostalAddressSyntaxChecker
065         */
066        @Override
067        public PostalAddressSyntaxChecker build()
068        {
069            return new PostalAddressSyntaxChecker( oid );
070        }
071    }
072
073    
074    /**
075     * Creates a new instance of PostalAddressSyntaxChecker.
076     * 
077     * @param oid The OID to use for this SyntaxChecker
078     */
079    private PostalAddressSyntaxChecker( String oid )
080    {
081        super( oid );
082    }
083
084    
085    /**
086     * @return An instance of the Builder for this class
087     */
088    public static Builder builder()
089    {
090        return new Builder();
091    }
092
093
094    /**
095     * {@inheritDoc}
096     */
097    @Override
098    public boolean isValidSyntax( Object value )
099    {
100        String strValue;
101
102        if ( value == null )
103        {
104            if ( LOG.isDebugEnabled() )
105            {
106                LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, "null" ) );
107            }
108            
109            return false;
110        }
111
112        if ( value instanceof String )
113        {
114            strValue = ( String ) value;
115        }
116        else if ( value instanceof byte[] )
117        {
118            strValue = Strings.utf8ToString( ( byte[] ) value );
119        }
120        else
121        {
122            strValue = value.toString();
123        }
124
125        if ( strValue.length() == 0 )
126        {
127            if ( LOG.isDebugEnabled() )
128            {
129                LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
130            }
131            
132            return false;
133        }
134
135        // Search for the '$' separator
136        int dollar = strValue.indexOf( '$' );
137
138        if ( dollar == -1 )
139        {
140            // No '$' => only a dstring
141            LOG.debug( I18n.msg( I18n.MSG_04489_SYNTAX_VALID, value ) );
142            return true;
143        }
144
145        int pos = 0;
146        do
147        {
148            // check that the element between each '$' is not empty
149            String address = strValue.substring( pos, dollar );
150
151            if ( Strings.isEmpty( address ) )
152            {
153                if ( LOG.isDebugEnabled() )
154                {
155                    LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
156                }
157                
158                return false;
159            }
160
161            pos = dollar + 1;
162
163            if ( pos == strValue.length() )
164            {
165                // we should not have a '$' at the end
166                if ( LOG.isDebugEnabled() )
167                {
168                    LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
169                }
170                
171                return false;
172            }
173
174            dollar = strValue.indexOf( '$', pos );
175        }
176        while ( dollar > -1 );
177
178        return true;
179    }
180}