org.lockss.protocol.PeerAddress Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lockss-core Show documentation
The Slimmed Down LOCKSS Daemon Core
The newest version!
/*
 * $Id$
 */

/*

Copyright (c) 2004 Board of Trustees of Leland Stanford Jr. University,
all rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
STANFORD UNIVERSITY BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of Stanford University shall not
be used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from Stanford University.

*/
package org.lockss.protocol;

import java.util.*;
import java.net.*;
import org.lockss.util.*;
import org.lockss.util.net.IPAddr;
import org.apache.oro.text.regex.*;

/**
 * Abstraction of protocol-specific peer addresses, currently UDP (V1) or
 * TCP (V3).  Should be used only by comm code when necessary to establish
 * a connection to the peer.  For peer identification purposes, always use
 * {@link PeerIdentity}
 */

// Everything in here should be package access.  It's public only so it's
// included in javadoc

public abstract class PeerAddress {
  static Logger log = Logger.getLogger();

  private String key;

  protected PeerAddress(String key) {
    this.key = key;
  }

  public static PeerAddress makePeerAddress(PeerIdentity pid)
      throws IdentityManager.MalformedIdentityKeyException {
    return makePeerAddress(pid.getIdString());
  }

  private static Pattern V3_TCP_PAT =
    RegexpUtil.uncheckedCompile("TCP:\\[([0-9a-f.:]+)\\]:([0-9]+)",
				Perl5Compiler.CASE_INSENSITIVE_MASK);

  public static PeerAddress makePeerAddress(String key)
      throws IdentityManager.MalformedIdentityKeyException {
    // V3 addresses start with "TCP:", to allow for other protocols (e.g.,
    // SOAP).

    String ip;
    try {
      Perl5Matcher matcher = RegexpUtil.getMatcher();
      if (matcher.contains(key, V3_TCP_PAT)) {
	// V3 identity
	MatchResult matchResult = matcher.getMatch();
	ip = matchResult.group(1);
	int port = Integer.parseInt(matchResult.group(2));
	return new Tcp(key, IPAddr.getByName(ip), port);
      } else {
	// assume V1 identity
	ip = key;
	checkIpAddr(ip);
	return new Udp(key, IPAddr.getByName(ip));
      }      
    } catch (UnknownHostException e) {
      throw new
	IdentityManager.MalformedIdentityKeyException("Unparseable PeerId: " +
						      key + ": " +
						      e.toString());
    } catch (RuntimeException e) {
      throw new
	IdentityManager.MalformedIdentityKeyException("Unparseable PeerId: " +
						      key + ": " +
						      e.toString());
    }
  }

  public boolean isAllowed(IpFilter filter) {
    return false;
  }    

  abstract String getNormalizedKey();

  abstract boolean isStream();

  /** Check for legal numeric IP address, throw
   * MalformedIdentityKeyException if not.  Currently accepts only IPV4
   * addresses
   */
  private static void checkIpAddr(String addr)
      throws IdentityManager.MalformedIdentityKeyException {
    try {
      IpFilter.newAddr(addr);
    } catch (IpFilter.MalformedException e) {
      throw new IdentityManager.MalformedIdentityKeyException(e.toString());
    }
  }

  protected static abstract class Ip extends PeerAddress {
    IPAddr addr;

    private Ip(String key, IPAddr addr) {
      super(key);
      this.addr = addr;
    }

    protected IPAddr getIPAddr() {
      return addr;
    }

    public boolean isAllowed(IpFilter filter) {
      try {
	return filter != null && filter.isIpAllowed(addr.getHostAddress());
      } catch (IpFilter.MalformedException e) {
	return false;
      }
    }
  }

  protected static class Udp extends Ip {

    Udp(String key, IPAddr addr) {
      super(key, addr);
    }

    boolean isStream() {
      return false;
    }

    public boolean equals(Object o) {
      if (o instanceof Udp) {
	Udp u = (Udp)o;
	return getIPAddr().equals(u.getIPAddr());
      }
      return false;
    }

    String getNormalizedKey() {
      return addr.getHostAddress();
    }

    public int hashCode() {
      throw new UnsupportedOperationException("Use PeerIdentity for key, not PeerAddress");
    }

    public String toString() {
      return "[PeerAddr.Udp: " + addr.getHostAddress() + "]";
    }
  }

  public static class Tcp extends Ip {
    private int port;

    Tcp(String key, IPAddr addr, int port) {
      super(key, addr);
      if (port < 0 || port > 65535) {
	throw new IllegalArgumentException("Illegal TCP port: " + port);
      }
      this.port = (int)port;
    }

    public int getPort() {
      return port;
    }

    boolean isStream() {
      return true;
    }

    public boolean equals(Object o) {
      if (o instanceof Tcp) {
	Tcp t = (Tcp)o;
	return getIPAddr().equals(t.getIPAddr()) &&
	  getPort() == t.getPort();
      }
      return false;
    }

    String getNormalizedKey() {
      return IDUtil.ipAddrToKey(addr, port);
    }

    public int hashCode() {
      throw new UnsupportedOperationException("Use PeerIdentity for key, not PeerAddress");
    }

    public String toString() {
      return "[PeerAddr.Tcp: " + IDUtil.ipAddrToKey(addr, port) + "]";
    }
  }
}