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 an OtherMailbox according to 
032     * RFC 4517 :
033     * 
034     * OtherMailbox = mailbox-type DOLLAR mailbox
035     * mailbox-type = PrintableString
036     * mailbox      = IA5String
037     * 
038     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039     * @version $Rev$
040     */
041    public class OtherMailboxSyntaxChecker extends SyntaxChecker
042    {
043        /** A logger for this class */
044        private static final Logger LOG = LoggerFactory.getLogger( OtherMailboxSyntaxChecker.class );
045    
046        /** The serialVersionUID */
047        private static final long serialVersionUID = 1L;
048    
049        /**
050         * Creates a new instance of OtherMailboxSyntaxChecker.
051         */
052        public OtherMailboxSyntaxChecker()
053        {
054            super( SchemaConstants.OTHER_MAILBOX_SYNTAX );
055        }
056        
057        
058        /**
059         * {@inheritDoc}
060         */
061        public boolean isValidSyntax( Object value )
062        {
063            String strValue = null;
064    
065            if ( value == null )
066            {
067                LOG.debug( "Syntax invalid for '{}'", value );
068                return false;
069            }
070            
071            if ( value instanceof String )
072            {
073                strValue = ( String ) value;
074            }
075            else if ( value instanceof byte[] )
076            {
077                strValue = StringTools.utf8ToString( ( byte[] ) value ); 
078            }
079            else
080            {
081                strValue = value.toString();
082            }
083    
084            if ( strValue.length() == 0 )
085            {
086                LOG.debug( "Syntax invalid for '{}'", value );
087                return false;
088            }
089    
090            // Search for the '$' separator
091            int dollar = strValue.indexOf( '$' );
092            
093            if ( dollar == -1 )
094            {
095                // No '$' => error
096                LOG.debug( "Syntax invalid for '{}'", value );
097                return false;
098            }
099            
100            String mailboxType = strValue.substring( 0, dollar );
101            
102            String mailbox = ( ( dollar < strValue.length() - 1 ) ? 
103                strValue.substring( dollar + 1 ) : "" ); 
104            
105            // The mailbox should not contains a '$'
106            if ( mailbox.indexOf( '$' ) != -1 )
107            {
108                LOG.debug( "Syntax invalid for '{}'", value );
109                return false;
110            }
111                
112            // Check that the mailboxType is a PrintableString
113            if ( !StringTools.isPrintableString( mailboxType ) )
114            {
115                LOG.debug( "Syntax invalid for '{}'", value );
116                return false;
117            }
118            
119            // Check that the mailbox is an IA5String
120            boolean result = ( StringTools.isIA5String( mailbox ) );
121            
122            if ( result )
123            {
124                LOG.debug( "Syntax valid for '{}'", value );
125            }
126            else
127            {
128                LOG.debug( "Syntax invalid for '{}'", value );
129            }
130            
131            return result;
132        }
133    }