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 * https://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.i18n.I18n; 024import org.apache.directory.api.ldap.model.constants.SchemaConstants; 025import org.apache.directory.api.ldap.model.schema.SyntaxChecker; 026import org.apache.directory.api.util.Strings; 027 028 029/** 030 * A SyntaxChecker which verifies that a value is an OtherMailbox according to 031 * RFC 4517 : 032 * <pre> 033 * OtherMailbox = mailbox-type DOLLAR mailbox 034 * mailbox-type = PrintableString 035 * mailbox = IA5String 036 * </pre> 037 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 038 */ 039@SuppressWarnings("serial") 040public final class OtherMailboxSyntaxChecker extends SyntaxChecker 041{ 042 /** 043 * A static instance of OtherMailboxSyntaxChecker 044 */ 045 public static final OtherMailboxSyntaxChecker INSTANCE = 046 new OtherMailboxSyntaxChecker( SchemaConstants.OTHER_MAILBOX_SYNTAX ); 047 048 /** 049 * A static Builder for this class 050 */ 051 public static final class Builder extends SCBuilder<OtherMailboxSyntaxChecker> 052 { 053 /** 054 * The Builder constructor 055 */ 056 private Builder() 057 { 058 super( SchemaConstants.OTHER_MAILBOX_SYNTAX ); 059 } 060 061 062 /** 063 * Create a new instance of OtherMailboxSyntaxChecker 064 * @return A new instance of OtherMailboxSyntaxChecker 065 */ 066 @Override 067 public OtherMailboxSyntaxChecker build() 068 { 069 return new OtherMailboxSyntaxChecker( oid ); 070 } 071 } 072 073 074 /** 075 * Creates a new instance of OtherMailboxSyntaxChecker. 076 * 077 * @param oid The OID 078 */ 079 private OtherMailboxSyntaxChecker( String oid ) 080 { 081 super( oid ); 082 } 083 084 085 /** 086 * @return An instance of the Builder for this class 087 */ 088 public static Builder builder() 089 { 090 return new Builder(); 091 } 092 093 094 /** 095 * {@inheritDoc} 096 */ 097 @Override 098 public boolean isValidSyntax( Object value ) 099 { 100 String strValue; 101 102 if ( value == null ) 103 { 104 if ( LOG.isDebugEnabled() ) 105 { 106 LOG.debug( I18n.err( I18n.ERR_13210_SYNTAX_INVALID, "null" ) ); 107 } 108 109 return false; 110 } 111 112 if ( value instanceof String ) 113 { 114 strValue = ( String ) value; 115 } 116 else if ( value instanceof byte[] ) 117 { 118 strValue = Strings.utf8ToString( ( byte[] ) value ); 119 } 120 else 121 { 122 strValue = value.toString(); 123 } 124 125 if ( strValue.length() == 0 ) 126 { 127 if ( LOG.isDebugEnabled() ) 128 { 129 LOG.debug( I18n.err( I18n.ERR_13210_SYNTAX_INVALID, value ) ); 130 } 131 132 return false; 133 } 134 135 // Search for the '$' separator 136 int dollar = strValue.indexOf( '$' ); 137 138 if ( dollar == -1 ) 139 { 140 // No '$' => error 141 if ( LOG.isDebugEnabled() ) 142 { 143 LOG.debug( I18n.err( I18n.ERR_13210_SYNTAX_INVALID, value ) ); 144 } 145 146 return false; 147 } 148 149 String mailboxType = strValue.substring( 0, dollar ); 150 151 String mailbox = ( dollar < strValue.length() - 1 ) 152 ? strValue.substring( dollar + 1 ) : ""; 153 154 // The mailbox should not contains a '$' 155 if ( mailbox.indexOf( '$' ) != -1 ) 156 { 157 if ( LOG.isDebugEnabled() ) 158 { 159 LOG.debug( I18n.err( I18n.ERR_13210_SYNTAX_INVALID, value ) ); 160 } 161 162 return false; 163 } 164 165 // Check that the mailboxType is a PrintableString 166 if ( !Strings.isPrintableString( mailboxType ) ) 167 { 168 if ( LOG.isDebugEnabled() ) 169 { 170 LOG.debug( I18n.err( I18n.ERR_13210_SYNTAX_INVALID, value ) ); 171 } 172 173 return false; 174 } 175 176 // Check that the mailbox is an IA5String 177 boolean result = Strings.isIA5String( mailbox ); 178 179 if ( LOG.isDebugEnabled() ) 180 { 181 if ( result ) 182 { 183 LOG.debug( I18n.msg( I18n.MSG_13701_SYNTAX_VALID, value ) ); 184 } 185 else 186 { 187 LOG.debug( I18n.err( I18n.ERR_13210_SYNTAX_INVALID, value ) ); 188 } 189 } 190 191 return result; 192 } 193}