LocalClientRequestDispatcher.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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 General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package org.jboss.com.sun.corba.se.spi.protocol;

import org.omg.CORBA.portable.ServantObject;

/**
 * @author Harold Carr
 */

public interface LocalClientRequestDispatcher
{
    public boolean useLocalInvocation(org.omg.CORBA.Object self);

    public boolean is_local(org.omg.CORBA.Object self);

    /**
     * Returns a Java reference to the servant which should be used for this request. servant_preinvoke() is invoked by
     * a local stub. If a ServantObject object is returned, then its servant field has been set to an object of the
     * expected type (Note: the object may or may not be the actual servant instance). The local stub may cast the
     * servant field to the expected type, and then invoke the operation directly.
     * 
     * @param self
     *            The object reference which delegated to this delegate.
     * 
     * @param operation
     *            a string containing the operation name. The operation name corresponds to the operation name as it
     *            would be encoded in a GIOP request.
     * 
     * @param expectedType
     *            a Class object representing the expected type of the servant. The expected type is the Class object
     *            associated with the operations class of the stub's interface (e.g. A stub for an interface Foo, would
     *            pass the Class object for the FooOperations interface).
     * 
     * @return a ServantObject object. The method may return a null value if it does not wish to support this
     *         optimization (e.g. due to security, transactions, etc). The method must return null if the servant is not
     *         of the expected type.
     */
    public ServantObject servant_preinvoke(org.omg.CORBA.Object self, String operation, Class<?> expectedType);

    public void servant_postinvoke(org.omg.CORBA.Object self, ServantObject servant);
}

// End of file.