org.newsclub.net.unix.AFUNIXSocketAddress Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of junixsocket-common Show documentation
The newest version!
/**
 * junixsocket
 *
 * Copyright (c) 2009,2014 Christian Kohlschütter
 *
 * The author licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.newsclub.net.unix;

import java.io.File;
import java.io.IOException;
import java.net.InetSocketAddress;

/**
 * Describes an {@link InetSocketAddress} that actually uses AF_UNIX sockets instead of AF_INET.
 * 
 * The ability to specify a port number is not specified by AF_UNIX sockets, but we need it
 * sometimes, for example for RMI-over-AF_UNIX.
 * 
 * @author Christian Kohlschütter
 */
public class AFUNIXSocketAddress extends InetSocketAddress {

  private static final long serialVersionUID = 1L;
  private final String socketFile;

  /**
   * Creates a new {@link AFUNIXSocketAddress} that points to the AF_UNIX socket specified by the
   * given file.
   * 
   * @param socketFile The socket to connect to.
   */
  public AFUNIXSocketAddress(final File socketFile) throws IOException {
    this(socketFile, 0);
  }

  /**
   * Creates a new {@link AFUNIXSocketAddress} that points to the AF_UNIX socket specified by the
   * given file, assigning the given port to it.
   * 
   * @param socketFile The socket to connect to.
   * @param port The port associated with this socket, or {@code 0} when no port should be assigned.
   */
  public AFUNIXSocketAddress(final File socketFile, int port) throws IOException {
    super(0);
    if (port != 0) {
      NativeUnixSocket.setPort1(this, port);
    }
    this.socketFile = socketFile.getCanonicalPath();
  }

  /**
   * Returns the (canonical) file path for this {@link AFUNIXSocketAddress}.
   * 
   * @return The file path.
   */
  public String getSocketFile() {
    return socketFile;
  }

  @Override
  public String toString() {
    return getClass().getName() + "[host=" + getHostName() + ";port=" + getPort() + ";file="
        + socketFile + "]";
  }
}