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