/*
* Copyright (c) 1998, 2015, Oracle and/or its affiliates. All rights reserved.
* 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.omg.CORBA.portable;
This interface provides a dispatching mechanism for an incoming call.
It is invoked by the ORB to dispatch a request to a servant.
/**
This interface provides a dispatching mechanism for an incoming call.
It is invoked by the ORB to dispatch a request to a servant.
*/
public interface InvokeHandler {
Invoked by the ORB to dispatch a request to the servant.
ORB passes the method name, an InputStream containing the
marshalled arguments, and a ResponseHandler which the servant
uses to construct a proper reply.
Only CORBA SystemException may be thrown by this method.
The method must return an OutputStream created by the
ResponseHandler which contains the marshalled reply.
A servant must not retain a reference to the ResponseHandler
beyond the lifetime of a method invocation.
Servant behaviour is defined as follows:
1. Determine correct method, and unmarshal parameters from
InputStream.
2. Invoke method implementation.
3. If no user exception, create a normal reply using
ResponseHandler.
4. If user exception occurred, create exception reply using
ResponseHandler.
5. Marshal reply into OutputStream returned by
ResponseHandler.
6. Return OutputStream to ORB.
Params: - method – The method name.
- input – The
InputStream
containing the marshalled arguments. - handler – The
ResponseHandler
which the servant uses
to construct a proper reply
Throws: - SystemException – is thrown when invocation fails due to a CORBA system exception.
Returns: The OutputStream
created by the
ResponseHandler which contains the marshalled reply
/**
* Invoked by the ORB to dispatch a request to the servant.
*
* ORB passes the method name, an InputStream containing the
* marshalled arguments, and a ResponseHandler which the servant
* uses to construct a proper reply.
*
* Only CORBA SystemException may be thrown by this method.
*
* The method must return an OutputStream created by the
* ResponseHandler which contains the marshalled reply.
*
* A servant must not retain a reference to the ResponseHandler
* beyond the lifetime of a method invocation.
*
* Servant behaviour is defined as follows:
* <p>1. Determine correct method, and unmarshal parameters from
* InputStream.
* <p>2. Invoke method implementation.
* <p>3. If no user exception, create a normal reply using
* ResponseHandler.
* <p>4. If user exception occurred, create exception reply using
* ResponseHandler.
* <p>5. Marshal reply into OutputStream returned by
* ResponseHandler.
* <p>6. Return OutputStream to ORB.
*
* @param method The method name.
* @param input The <code>InputStream</code> containing the marshalled arguments.
* @param handler The <code>ResponseHandler</code> which the servant uses
* to construct a proper reply
* @return The <code>OutputStream</code> created by the
* ResponseHandler which contains the marshalled reply
* @throws SystemException is thrown when invocation fails due to a CORBA system exception.
*/
OutputStream _invoke(String method, InputStream input,
ResponseHandler handler)
throws org.omg.CORBA.SystemException;
}