View Javadoc
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.schema.SyntaxChecker;
26  import org.apache.directory.api.util.Strings;
27  
28  
29  /**
30   * A SyntaxChecker which verifies that a value is a Boolean according to RFC 1778.
31   * 
32   * From RFC 1778 :
33   * <pre>
34   * &lt;mail-preference&gt; ::= "NO-LISTS" | "ANY-LIST" | "PROFESSIONAL-LISTS"
35   * </pre>
36   *
37   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
38   */
39  @SuppressWarnings("serial")
40  public final class MailPreferenceSyntaxChecker extends SyntaxChecker
41  {
42      /**
43       * A static instance of MailPreferenceSyntaxChecker
44       */
45      public static final MailPreferenceSyntaxChecker INSTANCE = 
46          new MailPreferenceSyntaxChecker( SchemaConstants.MAIL_PREFERENCE_SYNTAX );
47      
48      /**
49       * A static Builder for this class
50       */
51      public static final class Builder extends SCBuilder<MailPreferenceSyntaxChecker>
52      {
53          /**
54           * The Builder constructor
55           */
56          private Builder()
57          {
58              super( SchemaConstants.MAIL_PREFERENCE_SYNTAX );
59          }
60          
61          
62          /**
63           * Create a new instance of MailPreferenceSyntaxChecker
64           * @return A new instance of MailPreferenceSyntaxChecker
65           */
66          @Override
67          public MailPreferenceSyntaxChecker build()
68          {
69              return new MailPreferenceSyntaxChecker( oid );
70          }
71      }
72  
73      
74      /**
75       * 
76       * Creates a new instance of MailPreferenceSyntaxChecker.
77       * 
78       * @param oid the oid to associate with this new SyntaxChecker
79       *
80       */
81      private MailPreferenceSyntaxChecker( String oid )
82      {
83          super( oid );
84      }
85  
86      
87      /**
88       * @return An instance of the Builder for this class
89       */
90      public static Builder builder()
91      {
92          return new Builder();
93      }
94  
95  
96      /**
97       * {@inheritDoc}
98       */
99      @Override
100     public boolean isValidSyntax( Object value )
101     {
102         String strValue;
103 
104         if ( value == null )
105         {
106             if ( LOG.isDebugEnabled() )
107             {
108                 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, "null" ) );
109             }
110             
111             return false;
112         }
113 
114         if ( value instanceof String )
115         {
116             strValue = ( String ) value;
117         }
118         else if ( value instanceof byte[] )
119         {
120             strValue = Strings.utf8ToString( ( byte[] ) value );
121         }
122         else
123         {
124             strValue = value.toString();
125         }
126 
127         if ( ( strValue.length() < 8 ) || ( strValue.length() > 18 ) )
128         {
129             if ( LOG.isDebugEnabled() )
130             {
131                 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
132             }
133             
134             return false;
135         }
136 
137         boolean result = ( "NO-LISTS".equals( strValue ) ) || ( "ANY-LIST".equals( strValue ) )
138             || ( "PROFESSIONAL-LISTS".equals( strValue ) );
139 
140         if ( LOG.isDebugEnabled() )
141         {
142             if ( result )
143             {
144                 LOG.debug( I18n.msg( I18n.MSG_04489_SYNTAX_VALID, value ) );
145             }
146             else
147             {
148                 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
149             }
150         }
151 
152         return result;
153     }
154 }