/usr/share/Ice-3.5.1/slice/Ice/ServantLocator.ice is in ice35-slice 3.5.1-5.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | // **********************************************************************
//
// Copyright (c) 2003-2013 ZeroC, Inc. All rights reserved.
//
// This copy of Ice is licensed to you under the terms described in the
// ICE_LICENSE file included in this distribution.
//
// **********************************************************************
#pragma once
[["cpp:header-ext:h"]]
#include <Ice/ObjectAdapterF.ice>
#include <Ice/Current.ice>
module Ice
{
/**
*
* A servant locator is called by an object adapter to
* locate a servant that is not found in its active servant map.
*
* @see ObjectAdapter
* @see ObjectAdapter#addServantLocator
* @see ObjectAdapter#findServantLocator
*
**/
local interface ServantLocator
{
/**
*
* Called before a request is dispatched if a
* servant cannot be found in the object adapter's active servant
* map. Note that the object adapter does not automatically insert
* the returned servant into its active servant map. This must be
* done by the servant locator implementation, if this is desired.
*
* {@link #locate} can throw any user exception. If it does, that exception
* is marshaled back to the client. If the Slice definition for the
* corresponding operation includes that user exception, the client
* receives that user exception; otherwise, the client receives
* {@link UnknownUserException}.
*
* If {@link #locate} throws any exception, the Ice run time does <em>not</em>
* call {@link finished}.
*
* <p class="Note">If you call {@link #locate} from your own code, you
* must also call {@link #finished} when you have finished using the
* servant, provided that {@link #locate} returned a non-null servant;
* otherwise, you will get undefined behavior if you use
* servant locators such as the {@link Freeze.Evictor}.
*
* @param curr Information about the current operation for which
* a servant is required.
*
* @param cookie A "cookie" that will be passed to {@link #finished}.
*
* @return The located servant, or null if no suitable servant has
* been found.
*
* @see ObjectAdapter
* @see Current
* @see #finished
*
**/
["UserException"] Object locate(Current curr, out LocalObject cookie);
/**
*
* Called by the object adapter after a request has been
* made. This operation is only called if {@link #locate} was called
* prior to the request and returned a non-null servant. This
* operation can be used for cleanup purposes after a request.
*
* {@link finished} can throw any user exception. If it does, that exception
* is marshaled back to the client. If the Slice definition for the
* corresponding operation includes that user exception, the client
* receives that user exception; otherwise, the client receives
* {@link UnknownUserException}.
*
* If both the operation and {@link #finished} throw an exception, the
* exception thrown by {@link #finished} is marshaled back to the client.
*
* @param curr Information about the current operation call for
* which a servant was located by {@link #locate}.
*
* @param servant The servant that was returned by {@link #locate}.
*
* @param cookie The cookie that was returned by {@link #locate}.
*
* @see ObjectAdapter
* @see Current
* @see #locate
*
**/
["UserException"] void finished(Current curr, Object servant, LocalObject cookie);
/**
*
* Called when the object adapter in which this servant locator is
* installed is deactivated.
*
* @param category Indicates for which category the servant locator
* is being deactivated.
*
* @see ObjectAdapter#deactivate
* @see Communicator#shutdown
* @see Communicator#destroy
*
**/
void deactivate(string category);
};
};
|