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.misc;
22
23
24 import org.apache.directory.server.dhcp.options.DhcpOption;
25
26
27 /**
28 * This option is used by clients and servers to exchange vendor-
29 * specific information. The information is an opaque object of n
30 * octets, presumably interpreted by vendor-specific code on the clients
31 * and servers. The definition of this information is vendor specific.
32 * The vendor is indicated in the vendor class identifier option.
33 * Servers not equipped to interpret the vendor-specific information
34 * sent by a client MUST ignore it (although it may be reported).
35 * Clients which do not receive desired vendor-specific information
36 * SHOULD make an attempt to operate without it, although they may do so
37 * (and announce they are doing so) in a degraded mode.
38 *
39 * If a vendor potentially encodes more than one item of information in
40 * this option, then the vendor SHOULD encode the option using
41 * "Encapsulated vendor-specific options" as described below:
42 * The Encapsulated vendor-specific options field SHOULD be encoded as a
43 * sequence of code/length/value fields of identical syntax to the DHCP
44 * options field with the following exceptions:
45 *
46 * 1) There SHOULD NOT be a "magic cookie" field in the encapsulated
47 * vendor-specific extensions field.
48 *
49 * 2) Codes other than 0 or 255 MAY be redefined by the vendor within
50 * the encapsulated vendor-specific extensions field, but SHOULD
51 * conform to the tag-length-value syntax defined in section 2.
52 *
53 * 3) Code 255 (END), if present, signifies the end of the
54 * encapsulated vendor extensions, not the end of the vendor
55 * extensions field. If no code 255 is present, then the end of
56 * the enclosing vendor-specific information field is taken as the
57 * end of the encapsulated vendor-specific extensions field.
58 *
59 * The code for this option is 43 and its minimum length is 1.
60 *
61 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
62 */
63 public class VendorSpecificInformation extends DhcpOption
64 {
65 /*
66 * @see org.apache.directory.server.dhcp.options.DhcpOption#getTag()
67 */
68 public byte getTag()
69 {
70 return 43;
71 }
72 }