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  
21  package org.apache.directory.server.dhcp.options.dhcp;
22  
23  
24  import org.apache.directory.server.dhcp.options.ByteOption;
25  
26  
27  /**
28   * This option is used to indicate that the DHCP 'sname' or 'file'
29   * fields are being overloaded by using them to carry DHCP options. A
30   * DHCP server inserts this option if the returned parameters will
31   * exceed the usual space allotted for options.
32   * 
33   * If this option is present, the client interprets the specified
34   * additional fields after it concludes interpretation of the standard
35   * option fields.
36   * 
37   * The code for this option is 52, and its length is 1.  Legal values
38   * for this option are:
39   * 
40   *         Value   Meaning
41   *         -----   --------
42   *           1     the 'file' field is used to hold options
43   *           2     the 'sname' field is used to hold options
44   *           3     both fields are used to hold options
45   * 
46   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
47   * @version $Rev: 638228 $, $Date: 2008-03-18 07:12:41 +0100 (Di, 18 Mär 2008) $
48   */
49  public class OptionOverload extends ByteOption
50  {
51      /*
52       * @see org.apache.directory.server.dhcp.options.DhcpOption#getTag()
53       */
54      public byte getTag()
55      {
56          return 52;
57      }
58  }