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.asn1.ber.tlv;
21
22
23 import org.apache.directory.api.asn1.DecoderException;
24
25
26 /**
27 * A MBean used to get stats on the decoding process.
28 *
29 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
30 */
31 public interface TLVBerDecoderMBean
32 {
33 /**
34 * Set the number of bytes that can be used to encode the Value length,
35 * including the first byte. Max is 127 if the Length use a definite form,
36 * default is 1
37 *
38 * @param length the number of byte to use
39 * @throws DecoderException Thrown if the indefinite length is
40 * allowed or if the length's Length is above 126 bytes
41 */
42 void setMaxLengthLength( int length ) throws DecoderException;
43
44
45 /**
46 * Set the maximum number of bytes that should be used to encode a Tag
47 * label, including the first byte. Default is 1, no maximum
48 *
49 * @param length The length to use
50 */
51 void setMaxTagLength( int length );
52
53
54 /** Allow indefinite length. */
55 void allowIndefiniteLength();
56
57
58 /** Disallow indefinite length. */
59 void disallowIndefiniteLength();
60
61
62 /**
63 * Get the actual maximum number of bytes that can be used to encode the
64 * Length
65 *
66 * @return The maximum bytes of the Length
67 */
68 int getMaxLengthLength();
69
70
71 /**
72 * Get the actual maximum number of bytes that can be used to encode the Tag
73 *
74 * @return The maximum length of the Tag
75 */
76 int getMaxTagLength();
77
78
79 /**
80 * Tell if indefinite length form could be used for Length
81 *
82 * @return <code>true</code> if the Indefinite form is allowed
83 */
84 boolean isIndefiniteLengthAllowed();
85 }