org.omg.PortableInterceptor

Interface ServerRequestInfoOperations

All Superinterfaces:
RequestInfoOperations
Known Subinterfaces:
ServerRequestInfo

public interface ServerRequestInfoOperations
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. * *
receive_request_
service_contexts
receive_request send_reply send_exception send_other
Inherited from RequestInfoOperations:
arguments no yes1 yes no2 no2
exceptions no yes
contexts no yes
operation_context no yes yes no no
result no no yes no no
reply_status no no yes
forward_reference no yes2
get_request_service_context yes no yes
get_reply_service_context no no yes
request_id yes
operation yes
response_expected yes
sync_scope yes
get_slot yes
ServerRequestInfo-specific:
get_server_policy yes
add_reply_service_context yes
set_slot yes
sending_exception no yes no
object_id no yes yes yes3 yes3
adapter_id no yes yes yes3 yes3
target_most_derived_interface no yes no
target_is_a no yes no
receive_request_
service_contexts
receive_request send_reply send_exception send_other
  1. When ServerRequestInfo is passed to receive_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 attribute is not LOCATION_FORWARD, accessing this attribute throws BAD_INV_ORDER minor code of 14.
  3. If the servant locator caused a location forward, or thrown an exception, this attribute/operation may not be available (NO_RESOURCES with a standard minor code of 1 will be thrown).

Method Summary

byte[]
adapter_id()
Get the identifier for the object adapter (POA).
void
add_reply_service_context(ServiceContext service_context, boolean replace)
Allows the interceptor to add service contexts to the request.
Policy
get_server_policy(int type)
Return the policy of the given type that applies to this operation.
byte[]
object_id()
Get the object_id describing the target of the operation invocation.
Any
sending_exception()
Get the exception to be returned to the client.
void
set_slot(int id, Any data)
Allows the interceptor to set a slot in the PortableInterceptor.Current that is in the scope of the request.
boolean
target_is_a(String id)
Checks if the servant is the given repository id.
String
target_most_derived_interface()
Get the most derived (most specific) repository Id of the servant.

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

adapter_id

public byte[] adapter_id()
Get the identifier for the object adapter (POA).


add_reply_service_context

public void add_reply_service_context(ServiceContext service_context,
                                      boolean replace)
Allows the interceptor to add service contexts to the request. Such added contexts can carry arbitrary data and can be later accessed on the client side by the client request interceptor using RequestInfoOperations.get_reply_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.


get_server_policy

public Policy get_server_policy(int type)
            throws INV_POLICY
Return the policy of the given type that applies to this operation. This method should only be used with policies, produced by the registered PolicyFactory.

Parameters:
type - the type of the policy being requested.

Returns:
the policy that applies to this operation.

Throws:
INV_POLICY - minor 2 if no factory was registered to produce this type of policy or the policy is otherwise invalid.


object_id

public byte[] object_id()
Get the object_id describing the target of the operation invocation.


sending_exception

public Any sending_exception()
Get the exception to be returned to the client. If the returned Any cannot not support holding of that exception, it holds UNKNOWN minor 1 instead.

Returns:
an Any, holding exception that has been thrown and will be returned to client.


set_slot

public void set_slot(int id,
                     Any data)
            throws InvalidSlot
Allows the interceptor to set a slot in the PortableInterceptor.Current that is in the scope of the request.

Parameters:
id - the Id of the slot.
data - the value of the slot, replacing the previous value.

Throws:
InvalidSlot - if the slot with the given Id does not exist.

See Also:
RequestInfoOperations.get_slot(int), org.omg.PortableInterceptor.Current


target_is_a

public boolean target_is_a(String id)
Checks if the servant is the given repository id.

Parameters:

Returns:
true if the servant repository id matches the parameter, false otherwise.


target_most_derived_interface

public String target_most_derived_interface()
Get the most derived (most specific) repository Id of the servant.

Returns:
the repository id of the servant.


ServerRequestInfoOperations.java -- Copyright (C) 2005 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.