Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.omg.PortableInterceptor

Interface ClientRequestInfoOperations

All Superinterfaces:
RequestInfoOperations
Known Subinterfaces:
ClientRequestInfo
public interface ClientRequestInfoOperations
extends RequestInfoOperations
Provides request information, accessible for the ClientRequestInterceptor. Some methods of this interface are not valid at all interception points. The following table shows the validity of each method. If it is not valid, BAD_INV_ORDER minor 14 will be thrown.
send_requestsend_pollreceive_replyreceive_exceptionreceive_other
Inherited from RequestInfoOperations:
argumentsyes 1no yesno no
exceptionsyesno yes
contextsyesno yes
operation_contextyesno yes
resultno no yesno no
sync_scopeyesno yes
reply_statusno no yes
forward_referencenonoyes 2
get_request_service_contextyesno yes
get_reply_service_contextno no yes
request_idyes
operationyes
response_expectedyes
get_slotyes
ClientRequestInfo-specific:
targetyes
effective_targetyes
effective_profileyes
received_exceptionnoyesno
received_exception_idnoyesno
get_effective_componentyesno yes
get_effective_componentsyesno yes
get_request_policyyesno yes
add_request_service_contextyesno
send_requestsend_pollreceive_replyreceive_exceptionreceive_other
  1. When ClientRequestInfo is passed to send_request, there is an entry in the list for every argument, but only the in and inout arguments will be available.
  2. If the reply_status atribute is not LOCATION_FORWARD, accessing this attribute will throw BAD_INV_ORDER with a standard minor code of 14.

Method Summary

void
add_request_service_context(ServiceContext service_context, boolean replace)
Allows the interceptor to add the service contexts to the request.
TaggedProfile
effective_profile()
Returns the tagged profile (IOR) of the invocation target.
Object
effective_target()
Returns the object on that the operation will be invoked after handling the possible forwarding.
TaggedComponent
get_effective_component(int id)
Returns the given component of the invocation target profile.
TaggedComponent[]
get_effective_components(int id)
Returns the given components of the invocation target profile.
Policy
get_request_policy(int type)
This should return the policy of the given type that applies to this operation, but it is not implemented up till JDK 1.5 inclusive.
Any
received_exception()
Returns the remote exception that was thrown on the server side.
String
received_exception_id()
Returns the repository id of the remote exception that was thrown on the server side.
Object
target()
Returns the object on that the client has invoked the the operation.

Methods inherited from interface org.omg.PortableInterceptor.RequestInfoOperations

arguments, contexts, exceptions, forward_reference, get_reply_service_context, get_request_service_context, get_slot, operation, operation_context, reply_status, request_id, response_expected, result, sync_scope

Method Details

add_request_service_context

public void add_request_service_context(ServiceContext service_context,
                                        boolean replace)
Allows the interceptor to add the service contexts to the request. Such added contexts can carry arbitrary data and can be later accessed on the server side by the server request interceptor, using RequestInfoOperations.get_request_service_context(int).
Parameters:
service_context - the context to add.
replace - if true, the existing context with the same Id will be replaced. If false, the BAD_INV_ORDER will be thrown in that case.
Throws:
BAD_INV_ORDER - minor 15 if the context with the same Id already exists and replace=false.

effective_profile

public TaggedProfile effective_profile()
Returns the tagged profile (IOR) of the invocation target. If the request was forwarded, the method returns the new location, shown by the forwarding message.
Returns:
the invocation IOR.

effective_target

public Object effective_target()
Returns the object on that the operation will be invoked after handling the possible forwarding.
Returns:
the final invocation target.
See Also:
target()

get_effective_component

public TaggedComponent get_effective_component(int id)
            throws BAD_PARAM
Returns the given component of the invocation target profile. If the profile contains multiple components with the same Id, it is not defined, which one will be returned.
Parameters:
id - the component id.
Returns:
the profile component with the given Id.
Throws:
BAD_PARAM - minor 28 in there are no any components with the given Id in the profile.

get_effective_components

public TaggedComponent[] get_effective_components(int id)
            throws BAD_PARAM
Returns the given components of the invocation target profile. This method is uses when the profile may contain multiple components with the same Id.
Parameters:
id - the component id.
Returns:
the array of all profile components with the given Id.
Throws:
BAD_PARAM - minor 28 in there are no any components with the given Id in the profile.

get_request_policy

public Policy get_request_policy(int type)
            throws INV_POLICY
This should return the policy of the given type that applies to this operation, but it is not implemented up till JDK 1.5 inclusive.
Parameters:
type - the type of the policy being requested.
Returns:
should return the policy that applies to this operation.

received_exception

public Any received_exception()
Returns the remote exception that was thrown on the server side.
Returns:
the Any, holding this exception.
See Also:
received_exception_id()

received_exception_id

public String received_exception_id()
Returns the repository id of the remote exception that was thrown on the server side.
Returns:
the exception repository id.
See Also:
received_exception()

target

public Object target()
Returns the object on that the client has invoked the the operation. If the request was forwarded, it will not be the same object that actually processed the request.
Returns:
the initial client invocation target.
See Also:
effective_target()
ClientRequestInfoOperations.java -- Copyright (C) 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath 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 for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About