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 *    http://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 */
020
021package org.apache.directory.server.dhcp.options.dhcp;
022
023
024import org.apache.directory.server.dhcp.options.ByteOption;
025
026
027/**
028 * This option is used to indicate that the DHCP 'sname' or 'file'
029 * fields are being overloaded by using them to carry DHCP options. A
030 * DHCP server inserts this option if the returned parameters will
031 * exceed the usual space allotted for options.
032 * 
033 * If this option is present, the client interprets the specified
034 * additional fields after it concludes interpretation of the standard
035 * option fields.
036 * 
037 * The code for this option is 52, and its length is 1.  Legal values
038 * for this option are:
039 * 
040 *         Value   Meaning
041 *         -----   --------
042 *           1     the 'file' field is used to hold options
043 *           2     the 'sname' field is used to hold options
044 *           3     both fields are used to hold options
045 * 
046 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
047 */
048public class OptionOverload extends ByteOption
049{
050    /*
051     * @see org.apache.directory.server.dhcp.options.DhcpOption#getTag()
052     */
053    public byte getTag()
054    {
055        return 52;
056    }
057}