org.identityconnectors.framework.api.RemoteFrameworkConnectionInfo Maven / Gradle / Ivy

/*
 * ====================
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.     
 * 
 * The contents of this file are subject to the terms of the Common Development 
 * and Distribution License("CDDL") (the "License").  You may not use this file 
 * except in compliance with the License.
 * 
 * You can obtain a copy of the License at 
 * http://IdentityConnectors.dev.java.net/legal/license.txt
 * See the License for the specific language governing permissions and limitations 
 * under the License. 
 * 
 * When distributing the Covered Code, include this CDDL Header Notice in each file
 * and include the License file at identityconnectors/legal/license.txt.
 * If applicable, add the following below this CDDL Header, with the fields 
 * enclosed by brackets [] replaced by your own identifying information: 
 * "Portions Copyrighted [year] [name of copyright owner]"
 * ====================
 */
package org.identityconnectors.framework.api;

import java.util.List;

import javax.net.ssl.TrustManager;

import org.identityconnectors.common.Assertions;
import org.identityconnectors.common.CollectionUtil;
import org.identityconnectors.common.security.GuardedString;


/**
 * Encapsulates all the connection information used to connect to
 * a remote instance of the connector framework.
 */
public final class RemoteFrameworkConnectionInfo {
    private final String _host;
    private final int _port;
    private final GuardedString _key;
    private final boolean _useSSL;
    private final List _trustManagers;
    private final int _timeout;
    
    /**
     * Creates a new instance of RemoteFrameworkConnectionInfo, using
     * a clear (non-ssl) connection and a 60-second timeout.
     * @param host The host to connect to
     * @param port The port to connect to
     * @param key The remote framework key
     */
    public RemoteFrameworkConnectionInfo(String host,
            int port,
            GuardedString key) {
        this(host,port,key,false,null,60*1000);
    }
    
    /**
     * Creates a new instance of RemoteFrameworkConnectionInfo.
     * @param host The host to connect to
     * @param port The port to connect to
     * @param key The remote framework key
     * @param useSSL Set to true if we are to connect via SSL.
     * @param trustManagers List of {@link TrustManager}'s to use
     * for establising the SSL connection. May be null or empty,
     * in which case the default installed providers for the JVM will
     * be used. Ignored if 'useSSL' is false. 
     * @param timeout The timeout to use (in milliseconds). A value of 0
     * means infinite timeout;
     */
    public RemoteFrameworkConnectionInfo(String host,
            int port,
            GuardedString key,
            boolean useSSL,
            List trustManagers,
            int timeout) {
        Assertions.nullCheck(host, "host");
        Assertions.nullCheck(key, "key");
        _host = host;
        _port = port;
        _key  = key;
        _useSSL = useSSL;
        _trustManagers = CollectionUtil.newReadOnlyList(trustManagers);
        _timeout = timeout;
    }
    
    /**
     * Returns the host to connect to.
     * @return The host to connect to.
     */
    public String getHost() {
        return _host;
    }
    
    /**
     * Returns the port to connect to
     * @return The port to connect to
     */
    public int getPort() {
        return _port;
    }
    
    /**
     * Returns the remote framework key
     * @return the remote framework key
     */
    public GuardedString getKey() {
        return _key;
    }
    
    /**
     * Returns true iff we are to use SSL to connect.
     * @return true iff we are to use SSL to connect.
     */
    public boolean getUseSSL() {
        return _useSSL;
    }
        
    /**
     * Returns the list of {@link TrustManager}'s. to use when establishing
     * the connection.
     * @return The list of {@link TrustManager}'s.
     */
    public List getTrustManagers() {
        return _trustManagers;
    }
    
    /**
     * Returns the timeout (in milliseconds) to use for the connection.
     * A value of zero means infinite timeout.
     * @return the timeout (in milliseconds) to use for the connection.
     */
    public int getTimeout() {
        return _timeout;
    }
    
    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals(Object o) {
        if ( o instanceof RemoteFrameworkConnectionInfo ) {
            RemoteFrameworkConnectionInfo other = 
                (RemoteFrameworkConnectionInfo)o;
            if (!getHost().equals(other.getHost())) {
                return false;
            }
            if (getPort() != other.getPort()) {
                return false;
            }
            if (getUseSSL() != other.getUseSSL()) {
                return false;
            }
            if (!getTrustManagers().equals(other.getTrustManagers())) {
                return false;
            }
            if (!getKey().equals(other.getKey())) {
                return false;
            }
            if (getTimeout() != other.getTimeout()) {
                return false;
            }
            
            return true;
        }
        return false;
    }
    
    /**
     * {@inheritDoc}
     */
    @Override
    public int hashCode() {
        return _host.hashCode() ^ _port;
    }
    
    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        return "{host="+_host+", port="+_port+"}";
    }
    
}