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 java.text.ParseException;
024
025import org.apache.directory.api.i18n.I18n;
026import org.apache.directory.api.ldap.model.constants.SchemaConstants;
027import org.apache.directory.api.ldap.model.schema.SchemaManager;
028import org.apache.directory.api.ldap.model.schema.SyntaxChecker;
029import org.apache.directory.api.ldap.model.subtree.SubtreeSpecificationChecker;
030import org.apache.directory.api.util.Strings;
031
032
033/**
034 * A SyntaxChecker which verifies that a value is a subtree specification.
035 * <p>
036 * It has been removed in RFC 4517
037 *  
038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039 */
040@SuppressWarnings("serial")
041public final class SubtreeSpecificationSyntaxChecker extends SyntaxChecker
042{
043    /** The associated checker */
044    private transient SubtreeSpecificationChecker subtreeSpecificationChecker;
045    
046    /**
047     * A static instance of SubtreeSpecificationSyntaxChecker
048     */
049    public static final SubtreeSpecificationSyntaxChecker INSTANCE = 
050        new SubtreeSpecificationSyntaxChecker( SchemaConstants.SUBTREE_SPECIFICATION_SYNTAX, null );
051    
052    /**
053     * A static Builder for this class
054     */
055    public static final class Builder extends SCBuilder<SubtreeSpecificationSyntaxChecker>
056    {
057        /** The schemaManager */
058        private SchemaManager schemaManager;
059        
060        /**
061         * The Builder constructor
062         */
063        private Builder()
064        {
065            super( SchemaConstants.SUBTREE_SPECIFICATION_SYNTAX );
066        }
067        
068        
069        public Builder setSchemaManager( SchemaManager schemaManager )
070        {
071            this.schemaManager = schemaManager;
072                
073            return this;
074        }
075        
076        
077        /**
078         * Create a new instance of SubtreeSpecificationSyntaxChecker
079         * @return A new instance of SubtreeSpecificationSyntaxChecker
080         */
081        @Override
082        public SubtreeSpecificationSyntaxChecker build()
083        {
084            return new SubtreeSpecificationSyntaxChecker( oid, schemaManager );
085        }
086    }
087    
088    /**
089     * Creates an instance of SubtreeSpecificationSyntaxChecker
090     * 
091     * @param oid The OID to use for this SyntaxChecker
092     */
093    private SubtreeSpecificationSyntaxChecker( String oid, SchemaManager schemaManager )
094    {
095        super( oid );
096        subtreeSpecificationChecker = new SubtreeSpecificationChecker( schemaManager );
097    }
098
099    
100    /**
101     * @return An instance of the Builder for this class
102     */
103    public static Builder builder()
104    {
105        return new Builder();
106    }
107
108
109    /**
110     * {@inheritDoc}
111     */
112    @Override
113    public boolean isValidSyntax( Object value )
114    {
115        String strValue;
116
117        if ( value == null )
118        {
119            if ( LOG.isDebugEnabled() )
120            {
121                LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, "null" ) );
122            }
123            
124            return false;
125        }
126
127        if ( value instanceof String )
128        {
129            strValue = ( String ) value;
130        }
131        else if ( value instanceof byte[] )
132        {
133            strValue = Strings.utf8ToString( ( byte[] ) value );
134        }
135        else
136        {
137            strValue = value.toString();
138        }
139
140        if ( strValue.length() == 0 )
141        {
142            if ( LOG.isDebugEnabled() )
143            {
144                LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
145            }
146            
147            return false;
148        }
149
150        try
151        {
152            synchronized ( subtreeSpecificationChecker )
153            {
154                subtreeSpecificationChecker.parse( strValue );
155            }
156
157            if ( LOG.isDebugEnabled() )
158            {
159                LOG.debug( I18n.msg( I18n.MSG_04489_SYNTAX_VALID, value ) );
160            }
161            
162            return true;
163        }
164        catch ( ParseException pe )
165        {
166            if ( LOG.isDebugEnabled() )
167            {
168                LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
169            }
170            
171            return false;
172        }
173    }
174}