1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.ldap.model.schema.syntaxCheckers;
21
22
23 import org.apache.directory.api.asn1.util.Oid;
24 import org.apache.directory.api.i18n.I18n;
25 import org.apache.directory.api.ldap.model.constants.SchemaConstants;
26 import org.apache.directory.api.ldap.model.schema.SyntaxChecker;
27 import org.apache.directory.api.util.Strings;
28
29
30 /**
31 * A SyntaxChecker which verifies that a value is a numeric oid and a length
32 * constraint according to RFC 4512.
33 * <p>
34 * From RFC 4512 :
35 * <pre>
36 * noidlen = numericoid [ LCURLY len RCURLY ]
37 * numericoid = number 1*( DOT number )
38 * len = number
39 * number = DIGIT | ( LDIGIT 1*DIGIT )
40 * DIGIT = %x30 | LDIGIT ; "0"-"9"
41 * LDIGIT = %x31-39 ; "1"-"9"
42 * DOT = %x2E ; period (".")
43 * LCURLY = %x7B ; left curly brace "{"
44 * RCURLY = %x7D ; right curly brace "}"
45 * </pre>
46 *
47 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
48 */
49 @SuppressWarnings("serial")
50 public final class OidLenSyntaxChecker extends SyntaxChecker
51 {
52 /**
53 * A static instance of OidLenSyntaxChecker
54 */
55 public static final OidLenSyntaxChecker INSTANCE =
56 new OidLenSyntaxChecker( SchemaConstants.OID_LEN_SYNTAX );
57
58 /**
59 * A static Builder for this class
60 */
61 public static final class Builder extends SCBuilder<OidLenSyntaxChecker>
62 {
63 /**
64 * The Builder constructor
65 */
66 private Builder()
67 {
68 super( SchemaConstants.OID_LEN_SYNTAX );
69 }
70
71
72 /**
73 * Create a new instance of OidLenSyntaxChecker
74 * @return A new instance of OidLenSyntaxChecker
75 */
76 @Override
77 public OidLenSyntaxChecker build()
78 {
79 return new OidLenSyntaxChecker( oid );
80 }
81 }
82
83
84 /**
85 *
86 * Creates a new instance of OidLenSyntaxChecker.
87 *
88 */
89 private OidLenSyntaxChecker( String oid )
90 {
91 super( oid );
92 }
93
94
95 /**
96 * @return An instance of the Builder for this class
97 */
98 public static Builder builder()
99 {
100 return new Builder();
101 }
102
103
104 /**
105 * {@inheritDoc}
106 */
107 @Override
108 public boolean isValidSyntax( Object value )
109 {
110 String strValue;
111
112 if ( value == null )
113 {
114 if ( LOG.isDebugEnabled() )
115 {
116 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, "null" ) );
117 }
118
119 return false;
120 }
121
122 if ( value instanceof String )
123 {
124 strValue = ( String ) value;
125 }
126 else if ( value instanceof byte[] )
127 {
128 strValue = Strings.utf8ToString( ( byte[] ) value );
129 }
130 else
131 {
132 strValue = value.toString();
133 }
134
135 if ( strValue.length() == 0 )
136 {
137 if ( LOG.isDebugEnabled() )
138 {
139 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
140 }
141
142 return false;
143 }
144
145 // We are looking at the first position of the len part
146 int pos = strValue.indexOf( '{' );
147
148 if ( pos < 0 )
149 {
150 // Not found ... but it may still be a valid OID
151 boolean result = Oid.isOid( strValue );
152
153 if ( LOG.isDebugEnabled() )
154 {
155 if ( result )
156 {
157 LOG.debug( I18n.msg( I18n.MSG_04489_SYNTAX_VALID, value ) );
158 }
159 else
160 {
161 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
162 }
163 }
164
165 return result;
166 }
167 else
168 {
169 // we should have a len value. First check that the OID is valid
170 String oid = strValue.substring( 0, pos );
171
172 if ( !Oid.isOid( oid ) )
173 {
174 if ( LOG.isDebugEnabled() )
175 {
176 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
177 }
178
179 return false;
180 }
181
182 String len = strValue.substring( pos );
183
184 // We must have a number and a '}' at the end
185 if ( len.charAt( len.length() - 1 ) != '}' )
186 {
187 // No final '}'
188 if ( LOG.isDebugEnabled() )
189 {
190 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
191 }
192
193 return false;
194 }
195
196 for ( int i = 1; i < len.length() - 1; i++ )
197 {
198 switch ( len.charAt( i ) )
199 {
200 case '0':
201 case '1':
202 case '2':
203 case '3':
204 case '4':
205 case '5':
206 case '6':
207 case '7':
208 case '8':
209 case '9':
210 break;
211
212 default:
213 if ( LOG.isDebugEnabled() )
214 {
215 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
216 }
217
218 return false;
219 }
220 }
221
222 if ( ( len.charAt( 1 ) == '0' ) && len.length() > 3 )
223 {
224 // A number can't start with a '0' unless it's the only
225 // number
226 if ( LOG.isDebugEnabled() )
227 {
228 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
229 }
230
231 return false;
232 }
233
234 if ( LOG.isDebugEnabled() )
235 {
236 LOG.debug( I18n.msg( I18n.MSG_04489_SYNTAX_VALID, value ) );
237 }
238
239 return true;
240 }
241 }
242 }