org.openmdx.base.resource.spi.RestInteractionSpec 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 Interaction Specification
 * Owner:       OMEX AG, Switzerland, http://www.omex.ch
 * ====================================================================
 *
 * This software is published under the BSD license as listed below.
 * 
 * Copyright (c) 2009-2011, 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.resource.spi;

import javax.resource.cci.InteractionSpec;

import org.openmdx.base.resource.Records;
import org.openmdx.base.resource.cci.RestFunction;
import org.openmdx.kernel.text.format.IndentingFormatter;


/**
 * Unmodifiable REST Interaction Specification
 */
public final class RestInteractionSpec implements InteractionSpec {

    /**
     * Constructor 
     *
     * @param function
     * @param interactionVerb
     */
    public RestInteractionSpec(
        RestFunction function, 
        int interactionVerb
    ) {
        this.function = function;
        this.interactionVerb = interactionVerb;
    }

    /**
     * Implements Serializable
     */
    private static final long serialVersionUID = -721366034760859071L;

    /**
     * The REST function
     */
    private final RestFunction function;
    
    /**
     * The interaction verb
     */
    private final int interactionVerb;

    private static final String[] INTERACTION_VERBS = {
        "SYNC_SEND",        
        "SYNC_SEND_RECEIVE",        
        "SYNC_RECEIVE"        
    };
    
    /**
     * Retrieve function.
     *
     * @return Returns the function.
     */
    public RestFunction getFunction() {
        return this.function;
    }

    /**
     * Retrieve the function by name 
     * 
     * @return the function by name 
     */
    public String getFunctionName(){
        return this.function.name();
    }

    /**
     * Retrieve the interaction verb.
     *
     * @return Returns the interaction verb
     */
    public int getInteractionVerb() {
        return this.interactionVerb;
    }
    
    /**
     * Retrieve the string representation of the interaction verb
     * 
     * @return the interaction verb by name
     */
    public String getInteractionVerbName(){
    	return INTERACTION_VERBS[this.interactionVerb];
    }
    
    @Override
    public String toString(
    ) {
        return IndentingFormatter.toString(
		    Records.getRecordFactory().asMappedRecord(
		        this.getClass().getName(), 
		        "openMDX/REST Interaction Spec", 
		        new String[]{
		            "function",
		            "interactionVerb"
		        },
		        new Object[]{
		            this.function,
		            getInteractionVerbName()
		        }
		    )
		);
    }

    /* (non-Javadoc)
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj) {
        if(obj instanceof RestInteractionSpec) {
            RestInteractionSpec that = (RestInteractionSpec) obj; 
            return that.function == this.function && that.interactionVerb == this.interactionVerb;
        } else {
            return false;
        }
    }

    /* (non-Javadoc)
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        int i = this.interactionVerb;
        if(this.function != null) {
            i += 4 * this.function.ordinal();
        }
        return i;
    }
    
}