org.jboss.ejb.client.EJBHomeLocator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 32.0.0.Final

Show newest version

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2011, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jboss.ejb.client;

import javax.ejb.EJBHome;

/**
 * A locator for an EJB's home interface.
 *
 * @param  the remote view type
 */
public final class EJBHomeLocator extends EJBLocator {

    private static final long serialVersionUID = -3040039191221970094L;

    /**
     * Construct a new instance.
     *
     * @param viewType     the view type
     * @param appName      the application name
     * @param moduleName   the module name
     * @param beanName     the bean name
     * @param distinctName the distinct name
     * @param affinity     the affinity
     */
    public EJBHomeLocator(final Class viewType, final String appName, final String moduleName, final String beanName, final String distinctName, final Affinity affinity) {
        super(viewType, appName, moduleName, beanName, distinctName, affinity);
    }

    /**
     * Construct a new instance.
     *
     * @param viewType     the view type
     * @param appName      the application name
     * @param moduleName   the module name
     * @param beanName     the bean name
     * @param distinctName the distinct name
     */
    public EJBHomeLocator(final Class viewType, final String appName, final String moduleName, final String beanName, final String distinctName) {
        this(viewType, appName, moduleName, beanName, distinctName, Affinity.NONE);
    }

    /**
     * Construct a new instance.
     *
     * @param viewType     the view type
     * @param appName      the application name
     * @param moduleName   the module name
     * @param beanName     the bean name
     * @param affinity     the affinity
     */
    public EJBHomeLocator(final Class viewType, final String appName, final String moduleName, final String beanName, final Affinity affinity) {
        this(viewType, appName, moduleName, beanName, null, affinity);
    }

    /**
     * Construct a new instance.
     *
     * @param viewType     the view type
     * @param appName      the application name
     * @param moduleName   the module name
     * @param beanName     the bean name
     */
    public EJBHomeLocator(final Class viewType, final String appName, final String moduleName, final String beanName) {
        this(viewType, appName, moduleName, beanName, null, Affinity.NONE);
    }

    /**
     * Construct a new instance from an original instance but with a new affinity.
     *
     * @param original the original locator
     * @param newAffinity the new affinity to use
     */
    public EJBHomeLocator(final EJBHomeLocator original, final Affinity newAffinity) {
        super(original, newAffinity);
    }

    public EJBLocator withNewAffinity(final Affinity affinity) {
        return new EJBHomeLocator(this, affinity);
    }

    /**
     * Get the hash code for this instance.
     *
     * @return the hash code for this instance
     */
    public int hashCode() {
        return super.hashCode();
    }

    /**
     * Determine whether this object is equal to another.
     *
     * @param other the other object
     * @return {@code true} if they are equal, {@code false} otherwise
     */
    public boolean equals(final Object other) {
        return other instanceof EJBHomeLocator && equals((EJBHomeLocator) other);
    }

    @SuppressWarnings("unchecked")
    public  EJBHomeLocator narrowTo(final Class type) {
        return (EJBHomeLocator) super.narrowTo(type);
    }

    @SuppressWarnings("unchecked")
    public  EJBHomeLocator narrowAsHome(final Class type) {
        if (type.isAssignableFrom(getViewType())) {
            return (EJBHomeLocator) this;
        }
        throw new ClassCastException(type.toString());
    }

    /**
     * Determine whether this object is equal to another.
     *
     * @param other the other object
     * @return {@code true} if they are equal, {@code false} otherwise
     */
    public boolean equals(final EJBLocator other) {
        return other instanceof EJBHomeLocator && equals((EJBHomeLocator) other);
    }

    /**
     * Determine whether this object is equal to another.
     *
     * @param other the other object
     * @return {@code true} if they are equal, {@code false} otherwise
     */
    public boolean equals(final EJBHomeLocator other) {
        return super.equals(other);
    }
}