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;
22  
23  
24  import java.io.UnsupportedEncodingException;
25  
26  
27  /**
28   * The Dynamic Host Configuration Protocol (DHCP) provides a framework for
29   * passing configuration information to hosts on a TCP/IP network. Configuration
30   * parameters and other control information are carried in tagged data items
31   * that are stored in the 'options' field of the DHCP message. The data items
32   * themselves are also called "options." 
33   * 
34   * This abstract base class is for options
35   * that carry a string.
36   * 
37   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
38   * @version $Rev: 551805 $, $Date: 2007-06-29 00:57:04 -0500 (Fr, 29 Jun 2007) $
39   */
40  public abstract class StringOption extends DhcpOption
41  {
42      private String string;
43  
44  
45      /*
46       * @see org.apache.directory.server.dhcp.options.DhcpOption#setData(byte[])
47       */
48      public void setData( byte[] data )
49      {
50          try
51          {
52              string = new String( data, "ASCII" );
53          }
54          catch ( UnsupportedEncodingException e )
55          {
56              // should not happen
57              throw new RuntimeException( "ASCII encoding unavailable" );
58          }
59      }
60  
61  
62      /*
63       * @see org.apache.directory.server.dhcp.options.DhcpOption#getData()
64       */
65      public byte[] getData()
66      {
67          if ( null == string )
68              return new byte[]
69                  {};
70  
71          try
72          {
73              return string.getBytes( "ASCII" );
74          }
75          catch ( UnsupportedEncodingException e )
76          {
77              // should not happen
78              throw new RuntimeException( "ASCII encoding unavailable" );
79          }
80      }
81  
82  
83      public String getString()
84      {
85          return string;
86      }
87  
88  
89      public void setString( String string )
90      {
91          this.string = string;
92      }
93  }