ReverseLookupDomains


1   /* ====================================================================
2    * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3    *
4    * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5    *
6    * Redistribution and use in source and binary forms, with or without
7    * modification, are permitted provided that the following conditions
8    * are met:
9    *
10   * 1. Redistributions of source code must retain the above copyright
11   *    notice, this list of conditions and the following disclaimer.
12   *
13   * 2. Redistributions in binary form must reproduce the above copyright
14   *    notice, this list of conditions and the following disclaimer in
15   *    the documentation and/or other materials provided with the
16   *    distribution.
17   *
18   * 3. The end-user documentation included with the redistribution,
19   *    if any, must include the following acknowledgment:
20   *       "This product includes software developed by Jcorporate Ltd.
21   *        (http://www.jcorporate.com/)."
22   *    Alternately, this acknowledgment may appear in the software itself,
23   *    if and wherever such third-party acknowledgments normally appear.
24   *
25   * 4. "Jcorporate" and product names such as "Expresso" must
26   *    not be used to endorse or promote products derived from this
27   *    software without prior written permission. For written permission,
28   *    please contact info@jcorporate.com.
29   *
30   * 5. Products derived from this software may not be called "Expresso",
31   *    or other Jcorporate product names; nor may "Expresso" or other
32   *    Jcorporate product names appear in their name, without prior
33   *    written permission of Jcorporate Ltd.
34   *
35   * 6. No product derived from this software may compete in the same
36   *    market space, i.e. framework, without prior written permission
37   *    of Jcorporate Ltd. For written permission, please contact
38   *    partners@jcorporate.com.
39   *
40   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43   * DISCLAIMED.  IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44   * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45   * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46   * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51   * SUCH DAMAGE.
52   * ====================================================================
53   *
54   * This software consists of voluntary contributions made by many
55   * individuals on behalf of the Jcorporate Ltd. Contributions back
56   * to the project(s) are encouraged when you make modifications.
57   * Please send them to support@jcorporate.com. For more information
58   * on Jcorporate Ltd. and its products, please see
59   * <http://www.jcorporate.com/>.
60   *
61   * Portions of this software are based upon other open source
62   * products and are subject to their respective licenses.
63   */
64  
65  package com.jcorporate.expresso.ext.dbobj;
66  
67  import com.jcorporate.expresso.core.db.DBConnection;
68  import com.jcorporate.expresso.core.db.DBException;
69  import com.jcorporate.expresso.core.dbobj.DBObject;
70  import com.jcorporate.expresso.core.dbobj.RequestContext;
71  
72  import java.lang.ref.Reference  ;
73  import java.lang.ref.SoftReference  ;
74  import java.net.InetAddress  ;
75  import java.util.Vector  ;
76  
77  
78  /**
79   * Class that maintains a database of all known top level domain codes.  Useful
80   * for testing whether a particular domain should be denied or not.
81   * See {@link com.jcorporate.expresso.ext.dbobj.RestrictedCountries} for sample usage.<br />
82   * <p/>
83   * This class derives from ISOCountryCodes since most top level domain names are
84   * simply the ISO country codes.  However, an additional table is necessary for
85   * all the additions such as .com, .biz, .uk, etc. <br />
86   * <p/>
87   * The domain information was from http://www.iana.org/
88   *
89   * @author Michael Rimov
90   * @since Expresso 5.0
91   */
92  public class ReverseLookupDomains
93          extends ISOCountryCodes {
94      public static final String   FLD_DOMAINCODE = "DomainCode";
95      public static final String   FLD_DESCRIPTION = "DomainDescrip";
96      public static final String   FLD_NOTES = "DomainNotes";
97  
98      /**
99       * Constructor
100      *
101      * @throws DBException if there's an initialization problem
102      */
103     public ReverseLookupDomains()
104             throws DBException {
105         super();
106     } /* User() */
107 
108     /**
109      * Constructor
110      *
111      * @param myConnection database connection for transactions
112      * @throws DBException if there's an initialization problem
113      */
114     public ReverseLookupDomains(DBConnection myConnection)
115             throws DBException {
116         super(myConnection);
117     } /* User(String) */
118 
119     /**
120      * Use over (String) constructor.  Initializes the object in the context
121      * of the user who's uid belongs to the parameter.
122      *
123      * @param uid the Uid of the user context
124      * @throws DBException if there's an initialization problem
125      */
126     public ReverseLookupDomains(int uid)
127             throws DBException {
128         super(uid);
129     }
130 
131     /**
132      * For using DBObjects within Controllers.  Initializes based upon the current
133      * user and the requested db. [Of course this can be modified later]
134      *
135      * @param request - The controller request handed to you by the framework.
136      * @throws DBException if there's an initialization problem
137      */
138     public ReverseLookupDomains(RequestContext request)
139             throws DBException {
140         super(request);
141     }
142 
143     /**
144      * This function populates the table with the current listing of ISO country codes
145      *
146      * @throws DBException if an error occurs while populating the table.
147      * @see com.jcorporate.expresso.core.dbobj.DBObject#populateDefaultValues
148      */
149     public synchronized void populateDefaultValues()
150             throws DBException {
151         int i;
152         String   countryCodes[][] = super.getCountryCodes();
153         int len = countryCodes.length;
154 
155         for (i = 0; i < len; i++) {
156             this.clear();
157             this.setField(FLD_DOMAINCODE,
158                     countryCodes[i][1].toLowerCase());
159 
160             if (!this.find()) {
161                 setField(FLD_DESCRIPTION, countryCodes[i][0]);
162                 this.add();
163             }
164         }
165 
166         String   internetCodes[][] = this.getInternetCodes();
167         len = internetCodes.length;
168 
169         for (i = 0; i < len; i++) {
170             this.clear();
171             this.setField(FLD_DOMAINCODE, internetCodes[i][1].toLowerCase());
172 
173             if (!this.find()) {
174                 setField(FLD_DESCRIPTION, internetCodes[i][0]);
175                 this.add();
176             }
177         }
178     } /* populateDefaultValues() */
179 
180 
181     /**
182      * Useful method for unit testing to make sure that everything got added during
183      * setup as expected.
184      *
185      * @return the length o
186      */
187     public int getExpectedDefaultPopulation() {
188         String   internetCodes[][] = this.getInternetCodes();
189         return internetCodes.length + super.getExpectedDefaultPopulation();
190     }
191 
192     /**
193      * @return Vector of ValidValue Value/Description pairs for ISO Country Codes
194      * @throws DBException If the values cannot be retrieved
195      */
196     public Vector   getValues()
197             throws DBException {
198         return getValuesDefault(FLD_DOMAINCODE, FLD_DESCRIPTION);
199     } /* getValues() */
200 
201 
202     /**
203      * @return instantiated DBObject
204      * @throws DBException if an error occurs while instantiating the object
205      * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject#getThisDBObj
206      */
207     public synchronized DBObject getThisDBObj()
208             throws DBException {
209         return new ReverseLookupDomains();
210     } /* getThisDBObj() */
211 
212 
213     /**
214      * Sets up the fields for use in this database
215      *
216      * @throws DBException if an error occurs while instantiating the object
217      */
218     protected void setupFields()
219             throws DBException {
220         setTargetTable("REVERSEDOMAINS");
221         setDescription("Reverse Domain Lookup Descriptions");
222         setCharset("ISO-8859-1");
223         addField(FLD_DOMAINCODE, "varchar", 20, false, "Domain Code");
224         addField(FLD_DESCRIPTION, "varchar", 128, false, "Domain Description");
225         addField(FLD_NOTES, "varchar", 128, true, "Misc. Notes");
226         setStringFilter(FLD_DOMAINCODE, "stripFilter");
227         setStringFilter(FLD_DESCRIPTION, "rawFilter");
228         addKey(FLD_DOMAINCODE);
229         setReadOnly(FLD_DOMAINCODE);
230     } /* setupFields() */
231 
232 
233     protected synchronized String  [][] getInternetCodes() {
234         synchronized (internetCodesLock) {
235             if (internetCodesRef == null || internetCodesRef.get() == null) {
236                 internetCodesRef = new SoftReference  (new String  [][]{
237                     {"Commercial Company", "com"}, {"Educational Institution", "edu"},
238                     {"Non-profit Organization", "org"}, {"Networking Company", "net"},
239                     {"Old Internet Backbone", "arpa"},
240                     {"Air Transportation Industry", "aero"},
241                     {"Commercial Business", "biz"}, {"Cooperative Association", "coop"},
242                     {"Information", "info"}, {"Museum", "museum"}, {"Individual", "name"},
243                     {"US Government", "gov"}, {"US Military", "mil"},
244                     {"International Treaty Organization", "int"},
245                     {"Commercial Company", "cc"}, {"United Kingdom", "uk"}
246                 });
247 
248             }
249 
250             return (String  [][]) internetCodesRef.get();
251         }
252     }
253 
254 
255     private static final Object   internetCodesLock = new Object  ();
256     private static Reference   internetCodesRef = null;
257 
258 
259     /**
260      * Use this function to lookup any domain names given the InetAddress
261      *
262      * @param ipAddress the address to check
263      * @return String: ex  'uk' or 'gov' or 'com'
264      * @throws DBException if an error occurs
265      */
266     public String   getDomainId(String   ipAddress)
267             throws DBException {
268         try {
269             InetAddress   addr = InetAddress.getByName(ipAddress);
270             String   hostName = addr.getHostName();
271             String   domain = hostName.substring(hostName.lastIndexOf(".") + 1);
272             ReverseLookupDomains rld = new ReverseLookupDomains(this.getRequestingUid());
273             rld.setDataContext(this.getDataContext());
274             rld.setField(FLD_DOMAINCODE, domain);
275 
276             if (!rld.find()) {
277                 throw new DBException("Unable to find domain entry for domain=" + domain +
278                         " ipaddress= " + ipAddress + " hostname= " + hostName);
279             } else {
280                 return rld.getField(FLD_DOMAINCODE);
281             }
282         } catch (java.net.UnknownHostException   uhe) {
283             throw new DBException("Unable to lookup host: " + ipAddress, uhe);
284         } catch (SecurityException   se) {
285             throw new DBException("Unable to lookup host: " + ipAddress +
286                     ".  You need to have 'socket.checkConnect' permissions enabled" +
287                     " in your security manager", se);
288         }
289     }
290 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags