org.openmdx.base.rest.cci.RestConnectionSpec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmdx-dalvik Show documentation
openMDX/Dalvik Library
There is a newer version: 2.18.10
/*
 * ====================================================================
 * Project:     openMDX/Core, http://www.openmdx.org/
 * Description: REST Connection Specification
 * Owner:       OMEX AG, Switzerland, http://www.omex.ch
 * ====================================================================
 *
 * This software is published under the BSD license as listed below.
 * 
 * Copyright (c) 2008-2012, OMEX AG, Switzerland
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * 
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in
 *   the documentation and/or other materials provided with the
 *   distribution.
 * 
 * * Neither the name of the openMDX team nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * ------------------
 * 
 * This product includes software developed by other organizations as
 * listed in the NOTICE file.
 */
package org.openmdx.base.rest.cci;

import java.io.Serializable;

import javax.resource.cci.ConnectionSpec;

/**
 * REST Connection Specification
 */
public class RestConnectionSpec implements ConnectionSpec, Serializable {

    /**
     * Constructor 
     */
    public RestConnectionSpec(
    ){
    	this(null, null);
    }
    
    /**
     * Constructor 
     *
     * @param user
     * @param password
     */
    public RestConnectionSpec(
        String user,
        String password
    ){
    	this(user, password, null, false);
    }

    /**
     * Constructor 
     *
     * @param user
     * @param password
     * @param tenant
     * @param bulkLoad
     */
    public RestConnectionSpec(
        String user,
        String password,
        Object tenant, 
        boolean bulkLoad
    ){
        this.userName = user;
        this.password = password;
        this.tenant = tenant;
        this.bulkLoad = bulkLoad;
    }

    /**
     * @serial JCA's standard property 'UserName'
     */
    private String userName;
    
    /**
     * @serial JCA's standard property 'Password'
     */
    private String password;

    /**
     * @serial The 'Tenant' property
     */
    private Object tenant;
    
    /**
     * @serial The 'BulkLoad' property
     */
    private boolean bulkLoad;
    
    /**
     * Implements Serializable
     */
    private static final long serialVersionUID = -1117165712221772605L;

    /**
     * Set userName.
     * 
     * @param userName The userName to set.
     */
    public void setUserName(String userName) {
        this.userName = userName;
    }

    /**
     * Retrieve user.
     *
     * @return Returns the user.
     */
    public String getUserName() {
        return this.userName;
    }
    
    /**
     * Set password.
     * 
     * @param password The password to set.
     */
    public void setPassword(String password) {
        this.password = password;
    }

    /**
     * Retrieve password.
     *
     * @return Returns the password.
     */
    public String getPassword() {
        return this.password;
    }

    
    /**
     * Retrieve the tenant
     * 
     * @return the tenant
     */
    public Object getTenant() {
		return tenant;
	}

    /**
     * Set the tenant
     * 
     * @param tenant
     */
	public void setTenant(Object tenant) {
		this.tenant = tenant;
	}

    /**
     * Retrieve the 'BulkLoad' property.
     *
     * @return the 'BulkLoad' property
     */
    public boolean isBulkLoad() {
        return this.bulkLoad;
    }
	
    /**
     * Set the 'BulkLoad' property.
     * 
     * @param bulkLoad true in case of bulk load
     */
    public void setBulkLoad(boolean bulkLoad) {
        this.bulkLoad = bulkLoad;
    }

    /**
     * Compares to objects
     * 
     * @param left
     * @param right
     * 
     * @return true if both are either null or equal
     */
    private static boolean areEqual(
        Object left,
        Object right
    ){
        return left == null ? right == null : left.equals(right);
    }
    
    private static int hashCode(Object object) {
        return object == null ? 0 : object.hashCode();
    }
    
    /* (non-Javadoc)
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object object) {
        if(object instanceof RestConnectionSpec) {
            RestConnectionSpec that = (RestConnectionSpec) object;
            return 
                this.bulkLoad == that.bulkLoad &&
                areEqual(this.userName, that.userName) &&
                areEqual(this.tenant, that.tenant);
        } else {
            return false;
        }
    }

    /* (non-Javadoc)
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        return 
            hashCode(this.userName) + 
            hashCode(this.tenant) + 
            Boolean.valueOf(this.bulkLoad).hashCode();
    }

    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString(
    ) {
        return 
            RestConnectionSpec.class.getName() + 
            ": userName=" + this.userName +
            ", tenant=" + this.tenant +
            ", bulkLoad=" + this.bulkLoad;
    }
    
}