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     */
020    package org.apache.directory.shared.ldap.schema.syntaxCheckers;
021    
022    
023    import org.apache.directory.shared.ldap.constants.SchemaConstants;
024    import org.apache.directory.shared.ldap.schema.SyntaxChecker;
025    import org.apache.directory.shared.ldap.util.StringTools;
026    import org.slf4j.Logger;
027    import org.slf4j.LoggerFactory;
028    
029    
030    /**
031     * A SyntaxChecker which verifies that a value is a Boolean according to RFC 1778.
032     * 
033     * From RFC 1778 :
034     * 
035     * <mail-preference> ::= "NO-LISTS" | "ANY-LIST" | "PROFESSIONAL-LISTS"
036     * 
037     *
038     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039     * @version $Rev$
040     */
041    public class MailPreferenceSyntaxChecker extends SyntaxChecker
042    {
043        /** A logger for this class */
044        private static final Logger LOG = LoggerFactory.getLogger( MailPreferenceSyntaxChecker.class );
045    
046        /** The serialVersionUID */
047        private static final long serialVersionUID = 1L;
048    
049        /**
050         * Creates a new instance of MailPreferenceSyntaxChecker.
051         */
052        public MailPreferenceSyntaxChecker()
053        {
054            super( SchemaConstants.MAIL_PREFERENCE_SYNTAX );
055        }
056        
057        /**
058         * 
059         * Creates a new instance of MailPreferenceSyntaxChecker.
060         * 
061         * @param oid the oid to associate with this new SyntaxChecker
062         *
063         */
064        protected MailPreferenceSyntaxChecker( String oid )
065        {
066            super( oid );
067        }
068        
069        
070        /**
071         * {@inheritDoc}
072         */
073        public boolean isValidSyntax( Object value )
074        {
075            String strValue =null;
076    
077            if ( value == null )
078            {
079                LOG.debug( "Syntax invalid for '{}'", value );
080                return false;
081            }
082            
083            if ( value instanceof String )
084            {
085                strValue = ( String ) value;
086            }
087            else if ( value instanceof byte[] )
088            {
089                strValue = StringTools.utf8ToString( ( byte[] ) value ); 
090            }
091            else
092            {
093                strValue = value.toString();
094            }
095    
096            if ( ( strValue.length() < 8 ) || ( strValue.length() > 18 ) )
097            {
098                LOG.debug( "Syntax invalid for '{}'", value );
099                return false;
100            }
101            
102            boolean result = ( ( "NO-LISTS".equals( strValue ) ) || ( "ANY-LIST".equals( strValue ) ) || 
103                ( "PROFESSIONAL-LISTS".equals( strValue ) ) );
104            
105            if ( result )
106            {
107                LOG.debug( "Syntax valid for '{}'", value );
108            }
109            else
110            {
111                LOG.debug( "Syntax invalid for '{}'", value );
112            }
113            
114            return result;
115        }
116    }