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.shared.kerberos.codec.actions;
21
22
23 import org.apache.directory.api.asn1.DecoderException;
24 import org.apache.directory.api.asn1.ber.Asn1Container;
25 import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
26 import org.apache.directory.api.asn1.ber.tlv.BerValue;
27 import org.apache.directory.api.asn1.ber.tlv.TLV;
28 import org.apache.directory.api.i18n.I18n;
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 read the Realm
36 *
37 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
38 */
39 public abstract class AbstractReadRealm<E extends Asn1Container> extends GrammarAction<E>
40 {
41 /** The logger */
42 private static final Logger LOG = LoggerFactory.getLogger( AbstractReadRealm.class );
43
44 /** Speedup for logs */
45 private static final boolean IS_DEBUG = LOG.isDebugEnabled();
46
47
48 /**
49 * Instantiates a new AbstractReadRealm action.
50 */
51 public AbstractReadRealm( String name )
52 {
53 super( name );
54 }
55
56
57 /**
58 * sets the relam value on the ASN.1 object present in the container
59 *
60 * @param realm the realm name
61 * @param container the container holding ASN.1 object
62 */
63 protected abstract void setRealm( String realm, E container );
64
65
66 /**
67 * {@inheritDoc}
68 */
69 public final void action( E container ) throws DecoderException
70 {
71 TLV tlv = container.getCurrentTLV();
72
73 // The Length should not be null
74 if ( tlv.getLength() == 0 )
75 {
76 LOG.error( I18n.err( I18n.ERR_01308_ZERO_LENGTH_TLV ) );
77
78 // This will generate a PROTOCOL_ERROR
79 throw new DecoderException( I18n.err( I18n.ERR_01309_EMPTY_TLV ) );
80 }
81
82 // The value is the realm
83 BerValue value = tlv.getValue();
84 String realm = Strings.utf8ToString( value.getData() );
85
86 if ( IS_DEBUG )
87 {
88 LOG.debug( "read realm value : {}", realm );
89 }
90
91 setRealm( realm, container );
92 }
93 }