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 * https://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.codec.actions.ldapResult;
21
22
23 import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
24 import org.apache.directory.api.asn1.ber.tlv.TLV;
25 import org.apache.directory.api.i18n.I18n;
26 import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
27 import org.apache.directory.api.ldap.model.message.LdapResult;
28 import org.apache.directory.api.ldap.model.message.Message;
29 import org.apache.directory.api.util.Strings;
30 import org.slf4j.Logger;
31 import org.slf4j.LoggerFactory;
32
33
34 /**
35 * The action used to set the LdapResult error message.
36 *
37 * <pre>
38 * LDAPResult ::= SEQUENCE {
39 * ...
40 * errorMessage LDAPString,
41 * ...
42 * </pre>
43 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
44 */
45 public class StoreErrorMessage extends GrammarAction<LdapMessageContainer<Message>>
46 {
47 /** The logger */
48 private static final Logger LOG = LoggerFactory.getLogger( StoreErrorMessage.class );
49
50 /**
51 * Instantiates a new error message action.
52 */
53 public StoreErrorMessage()
54 {
55 super( "Store error message" );
56 }
57
58
59 /**
60 * {@inheritDoc}
61 */
62 @Override
63 public void action( LdapMessageContainer<Message> container )
64 {
65 // Get the Value and store it in the BindResponse
66 TLV tlv = container.getCurrentTLV();
67 String errorMessage;
68
69 // We have to handle the special case of a 0 length error
70 // message
71 if ( tlv.getLength() == 0 )
72 {
73 errorMessage = "";
74 }
75 else
76 {
77 errorMessage = Strings.utf8ToString( tlv.getValue().getData() );
78 }
79
80 LdapResult ldapResult = container.getLdapResult();
81 ldapResult.setDiagnosticMessage( errorMessage );
82
83 // We can have an END transition
84 container.setGrammarEndAllowed( true );
85
86 if ( LOG.isDebugEnabled() )
87 {
88 LOG.debug( I18n.msg( I18n.MSG_05106_ERROR_MESSAGE_IS, errorMessage ) );
89 }
90 }
91 }