sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/impl/src/net/jxta/impl/id/binaryID/IDFormat.java

   1 /*
   2  * Copyright (c) 2001-2007 Sun Microsystems, Inc.  All rights reserved.
   3  *
   4  *  The Sun Project JXTA(TM) Software License
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions are met:
   8  *
   9  *  1. Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *
  12  *  2. Redistributions in binary form must reproduce the above copyright notice,
  13  *     this list of conditions and the following disclaimer in the documentation
  14  *     and/or other materials provided with the distribution.
  15  *
  16  *  3. The end-user documentation included with the redistribution, if any, must
  17  *     include the following acknowledgment: "This product includes software
  18  *     developed by Sun Microsystems, Inc. for JXTA(TM) technology."
  19  *     Alternately, this acknowledgment may appear in the software itself, if
  20  *     and wherever such third-party acknowledgments normally appear.
  21  *
  22  *  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
  23  *     not be used to endorse or promote products derived from this software
  24  *     without prior written permission. For written permission, please contact
  25  *     Project JXTA at http://www.jxta.org.
  26  *
  27  *  5. Products derived from this software may not be called "JXTA", nor may
  28  *     "JXTA" appear in their name, without prior written permission of Sun.
  29  *
  30  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
  31  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  32  *  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN
  33  *  MICROSYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  34  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  35  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
  36  *  OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  37  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  38  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  39  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40  *
  41  *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United
  42  *  States and other countries.
  43  *
  44  *  Please see the license information page at :
  45  *  <http://www.jxta.org/project/www/license.html> for instructions on use of
  46  *  the license in source files.
  47  *
  48  *  ====================================================================
  49  *
  50  *  This software consists of voluntary contributions made by many individuals
  51  *  on behalf of Project JXTA. For more information on Project JXTA, please see
  52  *  http://www.jxta.org.
  53  *
  54  *  This license is based on the BSD license adopted by the Apache Foundation.
  55  */
  56
  57 package net.jxta.impl.id.binaryID;
  58
  59
  60 import java.util.logging.Logger;
  61
  62
  63 /**
  64  * The 'BinaryID' format is a general purpose JXTA ID Format. It implements all of
  65  * the six standard ID types. It was originally created for the Java 2 SE
  66  * reference implementation. The 'BinaryID' format uses randomly generated BinaryIDs
  67  * as the mechanism for generating canonical values for the ids it provides.
  68  *
  69  * @author Daniel Brookshier <a HREF="mailto:turbogeek@cluck.com">turbogeek@cluck.com</a>
  70  */
  71 public class IDFormat {
  72
  73     /**
  74      * LOG4J Logger
  75      */
  76     private final static transient Logger LOG = Logger.getLogger(IDFormat.class.getName());
  77
  78     /**
  79      * This table maps our local private versions of the well known ids to the
  80      * globally known version.
  81      */
  82
  83     final static Object[][] wellKnownIDs = {
  84         { net.jxta.peergroup.PeerGroupID.worldPeerGroupID, net.jxta.impl.id.UUID.IDFormat.worldPeerGroupID}
  85                 ,
  86         { net.jxta.peergroup.PeerGroupID.defaultNetPeerGroupID, net.jxta.impl.id.UUID.IDFormat.defaultNetPeerGroupID}
  87     };
  88
  89     /**
  90      * The instantiator for this ID Format which is used by the IDFactory.
  91      */
  92     public static final net.jxta.impl.id.binaryID.Instantiator INSTANTIATOR = new net.jxta.impl.id.binaryID.Instantiator();
  93
  94     /**
  95      * Private Constructor. This class cannot be instantiated.
  96      */
  97     private IDFormat() {}
  98
  99     /**
 100      * Translate from well known ID to our locally encoded versions.
 101      *
 102      * @param input the id to be translated.
 103      * @return the translated ID or the input ID if no translation was needed.
 104      */
 105
 106     static net.jxta.id.ID translateFromWellKnown(net.jxta.id.ID input) {
 107         for (int eachWellKnown = 0; eachWellKnown < wellKnownIDs.length; eachWellKnown++) {
 108             net.jxta.id.ID aWellKnown = (net.jxta.id.ID) wellKnownIDs[eachWellKnown][0];
 109
 110             if (aWellKnown.equals(input)) {
 111                 return (net.jxta.id.ID) wellKnownIDs[eachWellKnown][1];
 112             }
 113         }
 114
 115         return input;
 116     }
 117
 118     /**
 119      * Translate from locally encoded versions to the well known versions.
 120      *
 121      * @param input the id to be translated.
 122      * @return the translated ID or the input ID if no translation was needed.
 123      */
 124
 125     static net.jxta.id.ID translateToWellKnown(net.jxta.id.ID input) {
 126         for (int eachWellKnown = 0; eachWellKnown < wellKnownIDs.length; eachWellKnown++) {
 127             net.jxta.id.ID aLocalEncoding = (net.jxta.id.ID) wellKnownIDs[eachWellKnown][1];
 128
 129             if (aLocalEncoding.equals(input)) {
 130                 return (net.jxta.id.ID) wellKnownIDs[eachWellKnown][0];
 131             }
 132         }
 133
 134         return input;
 135     }
 136
 137     /**
 138      * Utility method used to strip only the most significant peer group ID.
 139      * This prevents us from continiously appending grandparents to each child.
 140      * <p/>
 141      * <p/>
 142      * This method is used in PipeID and PeerID.
 143      * </p>
 144      *
 145      * @param peerGroupID Peer group ID to pull the child from.
 146      * @return Child of the peer group.
 147      */
 148     public static String childGroup(net.jxta.peergroup.PeerGroupID peerGroupID) {
 149         String parentStr = (String) peerGroupID.getUniqueValue();
 150         // Child is the first ID
 151         int first = parentStr.indexOf('.');
 152         String child = null;
 153
 154         if (first != -1) {
 155             child = parentStr.substring(0, first);
 156
 157         } else {
 158             child = parentStr;
 159         }
 160         return child;
 161     }
 162 }