package org.omg.PortableInterceptor; /** * org/omg/PortableInterceptor/ServerRequestInfoOperations.java . * Generated by the IDL-to-Java compiler (portable), version "3.2" * from ../../../../src/share/classes/org/omg/PortableInterceptor/Interceptors.idl * Tuesday, October 8, 2013 5:42:17 AM PDT */ /** * Request Information, accessible to server-side request interceptors. *
* Some attributes and operations on ServerRequestInfo
are not
* valid at all interception points. The following table shows the validity
* of each attribute or operation. If it is not valid, attempting to access
* it will result in a BAD_INV_ORDER
being thrown with a
* standard minor code of 14.
*
* * *
* | receive_request_ service_contexts |
* receive_request | *send_reply | *send_exception | *send_other | *
---|---|---|---|---|---|
Inherited from RequestInfo: | *|||||
request_id |
* yes | *yes | *yes | *yes | *yes |
operation |
* yes | *yes | *yes | *yes | *yes |
arguments |
* no | *yes1 | *yes | *no2 | *no2 * |
exceptions |
* no | *yes | *yes | *yes | *yes |
contexts |
* no | *yes | *yes | *yes | *yes |
operation_context |
* no | *yes | *yes | *no | *no | *
result |
* no | *no | *yes | *no | *no | *
response_expected |
* yes | *yes | *yes | *yes | *yes |
sync_scope |
* yes | *yes | *yes | *yes | *yes |
request_id | *yes | yes | yes | yes | yes |
operation | *yes | yes | yes | yes | yes |
arguments | *no | yes1 * | yes | no2 | *no2 * |
exceptions | *no | yes | yes | yes | yes |
contexts | *no | yes | yes | yes | yes |
operation_context | *no | yes | yes | no | no |
result | *no | no | yes | no | no |
response_expected | *yes | yes | yes | yes | yes |
sync_scope | *yes | yes | yes | yes | yes |
reply_status | *no | no | yes | yes | yes |
forward_reference | *no | no | no | no | yes2 * |
get_slot | *yes | yes | yes | yes | yes |
get_request_service_context | *yes | no | yes | yes | yes |
get_reply_service_context | *no | no | yes | yes | yes |
ServerRequestInfo-specific: | *|||||
sending_exception | *no | no | no | yes | no |
object_id | *no | yes | yes | yes3 | *yes3 * |
adapter_id | *no | yes | yes | yes3 | *yes3 * |
server_id | *no | yes | yes | yes | yes |
orb_id | *no | yes | yes | yes | yes |
adapter_name | *no | yes | yes | yes | yes |
target_most_derived_interface | *no | yes | no4 | *no4 | *no4 * |
get_server_policy | *yes | yes | yes | yes | yes |
set_slot | *yes | yes | yes | yes | yes |
target_is_a | *no | yes | no4 | *no4 | *no4 * |
add_reply_service_context | *yes | yes | yes | yes | yes |
ServerRequestInfo
is passed to
* receive_request
, there is an entry in the list for
* every argument, whether in, inout, or out. But only the in and
* inout arguments will be available.reply_status
attribute is not
* LOCATION_FORWARD
, accessing this attribute will throw
* BAD_INV_ORDER
with a standard minor code of 14.NO_RESOURCES
with a standard minor
* code of 1 will be thrown if it is not available.ServantLocator
, then the ORB invokes the interception
* point after it calls ServantLocator.postinvoke()
* If the exception is a user exception which cannot be inserted into
* an any (e.g., it is unknown or the bindings don't provide the
* TypeCode
), then this attribute will be an any
* containing the system exception UNKNOWN
with a
* standard minor code of 1.
*
* @see
* PortableInterceptor
package comments for
* limitations / unimplemented features
*/
org.omg.CORBA.Any sending_exception ();
/**
* Returns the opaque object_id
describing the target of
* the operation invocation.
*/
byte[] object_id ();
/**
* Returns the opaque identifier for the object adapter.
*/
byte[] adapter_id ();
/**
* Returns the server ID that was specified on ORB::init using the -ORBServerId
* argument.
*/
String server_id ();
/**
* Returns the ID that was used to create the ORB.
*/
String orb_id ();
/**
* Returns the sequence of strings that identifies the object
* adapter instance that is handling this request.
*/
String[] adapter_name ();
/**
* Returns the repository id for the most derived interface of the
* servant.
*/
String target_most_derived_interface ();
/**
* Returns the policy in effect for this operation for the given
* policy type. The returned CORBA.Policy
object shall
* only be a policy whose type was registered via
* register_policy_factory
.
*
* @param type The CORBA.PolicyType
which specifies the
* policy to be returned.
* @return The CORBA.Policy
obtained with the given
* policy type.
* @exception INV_POLICY thrown, with a standard minor code of 2, if
* a policy for the given type was not registered via
* register_policy_factory
.
* @see ORBInitInfo#register_policy_factory
*/
org.omg.CORBA.Policy get_server_policy (int type);
/**
* Allows an Interceptor to set a slot in the
* PortableInterceptor.Current
that is in the scope of
* the request. If data already exists in that slot, it will be
* overwritten.
*
* @param id The id of the slot.
* @param data The data, in the form of an any, to store in that slot.
* @exception InvalidSlot thrown if the ID does not define an allocated
* slot.
* @see Current
*/
void set_slot (int id, org.omg.CORBA.Any data) throws org.omg.PortableInterceptor.InvalidSlot;
/**
* Returns true if the servant is the given repository id,
* false if it is not.
*
* @param id The caller wants to know if the servant is this
* repository id.
* @return Is the servant the given RepositoryId?
*/
boolean target_is_a (String id);
/**
* Allows Interceptors to add service contexts to the request.
*
* There is no declaration of the order of the service contexts.
* They may or may not appear in the order that they are added.
*
* @param service_context The IOP.ServiceContext
to add to
* the reply.
* @param replace Indicates the behavior of this operation when a
* service context already exists with the given ID. If false,
* then BAD_INV_ORDER
with a standard minor code of 15
* is thrown. If true, then the existing service context is
* replaced by the new one.
* @exception BAD_INV_ORDER thrown, with a standard minor code of 15, if
* replace is false and a service context already exists with the
* given ID.
*/
void add_reply_service_context (org.omg.IOP.ServiceContext service_context, boolean replace);
} // interface ServerRequestInfoOperations