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.i18n.I18n;
24 import org.apache.directory.api.ldap.model.constants.SchemaConstants;
25 import org.apache.directory.api.ldap.model.name.Dn;
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 valid {@link Dn}. We just check
32 * that the {@link Dn} is valid, we don't need to verify each of the {@link Rdn} syntax.
33 *
34 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
35 */
36 @SuppressWarnings("serial")
37 public final class DnSyntaxChecker extends SyntaxChecker
38 {
39 /**
40 * A static instance of DnSyntaxChecker
41 */
42 public static final DnSyntaxChecker INSTANCE = new DnSyntaxChecker( SchemaConstants.DN_SYNTAX );
43
44 /**
45 * A static Builder for this class
46 */
47 public static final class Builder extends SCBuilder<DnSyntaxChecker>
48 {
49 /**
50 * The Builder constructor
51 */
52 private Builder()
53 {
54 super( SchemaConstants.DN_SYNTAX );
55 }
56
57
58 /**
59 * Create a new instance of DnSyntaxChecker
60 * @return A new instance of DnSyntaxChecker
61 */
62 @Override
63 public DnSyntaxChecker build()
64 {
65 return new DnSyntaxChecker( oid );
66 }
67 }
68
69
70 /**
71 * Creates a new instance of DNSyntaxChecker.
72 *
73 * @param oid The OID to use for this SyntaxChecker
74 */
75 private DnSyntaxChecker( String oid )
76 {
77 super( oid );
78 }
79
80
81 /**
82 * @return An instance of the Builder for this class
83 */
84 public static Builder builder()
85 {
86 return new Builder();
87 }
88
89
90 /**
91 * {@inheritDoc}
92 */
93 @Override
94 public boolean isValidSyntax( Object value )
95 {
96 String strValue;
97
98 if ( value == null )
99 {
100 if ( LOG.isDebugEnabled() )
101 {
102 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, "null" ) );
103 }
104
105 return false;
106 }
107
108 if ( value instanceof String )
109 {
110 strValue = ( String ) value;
111 }
112 else if ( value instanceof byte[] )
113 {
114 strValue = Strings.utf8ToString( ( byte[] ) value );
115 }
116 else
117 {
118 strValue = value.toString();
119 }
120
121 if ( strValue.length() == 0 )
122 {
123 // TODO: this should be a false, but for
124 // some reason, the principal is empty in
125 // some cases.
126 if ( LOG.isDebugEnabled() )
127 {
128 LOG.debug( I18n.msg( I18n.MSG_04489_SYNTAX_VALID, strValue ) );
129 }
130
131 return true;
132 }
133
134 // Check that the value is a valid Dn
135 boolean result = Dn.isValid( strValue );
136
137 if ( LOG.isDebugEnabled() )
138 {
139 if ( result )
140 {
141 LOG.debug( I18n.msg( I18n.MSG_04489_SYNTAX_VALID, strValue ) );
142 }
143 else
144 {
145 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, strValue ) );
146 }
147 }
148
149 return result;
150 }
151 }