doc/bundles/org.eclipse.ecf.doc/html/reference/api/org/eclipse/ecf/remoteservice/IRemoteServiceCallPolicy.html - gerrit/ecf/org.eclipse.ecf - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 -->
 <title>IRemoteServiceCallPolicy (Eclipse Communication Framework (ECF) 3.14.22 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta name="dc.created" content="2021-06-15">
 <meta name="description" content="declaration: package: org.eclipse.ecf.remoteservice, interface: IRemoteServiceCallPolicy">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
 <!--[if IE]>
 <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
 <![endif]-->
 <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script>
 </head>
 <body class="class-declaration">
 <script type="text/javascript">var data = {"i0":6};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 var pathtoroot = "../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flexBox">
 <header role="banner" class="flexHeader">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/IRemoteServiceCallPolicy.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-files/index-1.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <div class="navListSearch"><label for="search">SEARCH:</label>
 <input type="text" id="search" value="search" disabled="disabled">
 <input type="reset" id="reset" value="reset" disabled="disabled">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <div class="skipNav"><a id="skip.navbar.top">
 <!--   -->
 </a></div>
 </nav>
 </header>
 <div class="flexContent">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.ecf.remoteservice</a></div>
 <h1 title="Interface IRemoteServiceCallPolicy" class="title">Interface IRemoteServiceCallPolicy</h1>
 </div>
 <div class="contentContainer">
 <section class="description">
 <hr>
 <pre>public interface <span class="typeNameLabel">IRemoteServiceCallPolicy</span></pre>
 <div class="block">Interface providing the ability to add authorization on a remote service method call.</div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>6.0</dd>
 </dl>
 </section>
 <section class="summary">
 <ul class="blockList">
 <!-- ========== METHOD SUMMARY =========== -->
 <li class="blockList">
 <section class="methodSummary"><a id="method.summary">
 <!--   -->
 </a>
 <h2>Method Summary</h2>
 <div class="memberSummary">
 <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div>
 <div id="memberSummary_tabpanel" role="tabpanel">
 <table aria-labelledby="t0">
 <thead>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Method</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 </thead>
 <tbody>
 <tr class="altColor" id="i0">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkRemoteCall(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.remoteservice.IRemoteServiceRegistration,org.eclipse.ecf.remoteservice.IRemoteCall)">checkRemoteCall</a></span>&#8203;(<a href="../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>&nbsp;fromID,
 <a href="IRemoteServiceRegistration.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceRegistration</a>&nbsp;registration,
 <a href="IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a>&nbsp;remoteCall)</code></th>
 <td class="colLast">
 <div class="block">The following method is to be called before the remote service method call to check
  if the remote service method call is authorized.</div>
 </td>
 </tr>
 </tbody>
 </table>
 </div>
 </div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <li class="blockList">
 <section class="methodDetails"><a id="method.detail">
 <!--   -->
 </a>
 <h2>Method Details</h2>
 <ul class="blockList">
 <li class="blockList">
 <section class="detail">
 <h3><a id="checkRemoteCall(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.remoteservice.IRemoteServiceRegistration,org.eclipse.ecf.remoteservice.IRemoteCall)">checkRemoteCall</a></h3>
 <div class="memberSignature"><span class="returnType">void</span>&nbsp;<span class="memberName">checkRemoteCall</span>&#8203;(<span class="arguments"><a href="../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>&nbsp;fromID,
 <a href="IRemoteServiceRegistration.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceRegistration</a>&nbsp;registration,
 <a href="IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a>&nbsp;remoteCall)</span>
               throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></span></div>
 <div class="block">The following method is to be called before the remote service method call to check
  if the remote service method call is authorized.  Providers supporting this API
  should call any available implementing instance prior to actually
  invoking the given IRemoteCall.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>fromID</code> - container ID of the remote caller.
         May be <code>null</code>.</dd>
 <dd><code>registration</code> - Remote service registration associated
         with the given remoteCall.  Will not be <code>null</code>.</dd>
 <dd><code>remoteCall</code> - Remote method call to invoke locally (assuming this
         check passes).  Will not be <code>null</code>.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></code> - if remoteCall is not authorized for the
          given caller fromID</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 </div>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <nav role="navigation">
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a id="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/IRemoteServiceCallPolicy.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-files/index-1.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 </div>
 <a id="skip.navbar.bottom">
 <!--   -->
 </a>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 -->
	<title>IRemoteServiceCallPolicy (Eclipse Communication Framework (ECF) 3.14.22 API)</title>
	<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
	<meta name="dc.created" content="2021-06-15">
	<meta name="description" content="declaration: package: org.eclipse.ecf.remoteservice, interface: IRemoteServiceCallPolicy">
	<meta name="generator" content="javadoc/ClassWriterImpl">
	<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
	<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style">
	<script type="text/javascript" src="../../../../script.js"></script>
	<script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script>
	<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
	<!--[if IE]>
	<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
	<![endif]-->
	<script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script>
	<script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script>
	</head>
	<body class="class-declaration">
	<script type="text/javascript">var data = {"i0":6};
	var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
	var altColor = "altColor";
	var rowColor = "rowColor";
	var tableTab = "tableTab";
	var activeTableTab = "activeTableTab";
	var pathtoroot = "../../../../";
	loadScripts(document, 'script');</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<div class="flexBox">
	<header role="banner" class="flexHeader">
	<nav role="navigation">
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="topNav"><a id="navbar.top">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
	<a id="navbar.top.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../index.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="class-use/IRemoteServiceCallPolicy.html">Use</a></li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../../index-files/index-1.html">Index</a></li>
	<li><a href="../../../../help-doc.html">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.detail">Method</a></li>
	</ul>
	</div>
	<div class="navListSearch"><label for="search">SEARCH:</label>
	<input type="text" id="search" value="search" disabled="disabled">
	<input type="reset" id="reset" value="reset" disabled="disabled">
	</div>
	</div>
	<!-- ========= END OF TOP NAVBAR ========= -->
	<div class="skipNav"><a id="skip.navbar.top">
	<!-- -->
	</a></div>
	</nav>
	</header>
	<div class="flexContent">
	<main role="main">
	<!-- ======== START OF CLASS DATA ======== -->
	<div class="header">
	<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.ecf.remoteservice</a></div>
	<h1 title="Interface IRemoteServiceCallPolicy" class="title">Interface IRemoteServiceCallPolicy</h1>
	</div>
	<div class="contentContainer">
	<section class="description">
	<hr>
	<pre>public interface <span class="typeNameLabel">IRemoteServiceCallPolicy</span></pre>
	<div class="block">Interface providing the ability to add authorization on a remote service method call.</div>
	<dl>
	<dt><span class="simpleTagLabel">Since:</span></dt>
	<dd>6.0</dd>
	</dl>
	</section>
	<section class="summary">
	<ul class="blockList">
	<!-- ========== METHOD SUMMARY =========== -->
	<li class="blockList">
	<section class="methodSummary"><a id="method.summary">
	<!-- -->
	</a>
	<h2>Method Summary</h2>
	<div class="memberSummary">
	<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div>
	<div id="memberSummary_tabpanel" role="tabpanel">
	<table aria-labelledby="t0">
	<thead>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colSecond" scope="col">Method</th>
	<th class="colLast" scope="col">Description</th>
	</tr>
	</thead>
	<tbody>
	<tr class="altColor" id="i0">
	<td class="colFirst"><code>void</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkRemoteCall(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.remoteservice.IRemoteServiceRegistration,org.eclipse.ecf.remoteservice.IRemoteCall)">checkRemoteCall</a></span>(<a href="../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> fromID,
	<a href="IRemoteServiceRegistration.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceRegistration</a> registration,
	<a href="IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> remoteCall)</code></th>
	<td class="colLast">
	<div class="block">The following method is to be called before the remote service method call to check
	if the remote service method call is authorized.</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	</div>
	</section>
	</li>
	</ul>
	</section>
	<section class="details">
	<ul class="blockList">
	<!-- ============ METHOD DETAIL ========== -->
	<li class="blockList">
	<section class="methodDetails"><a id="method.detail">
	<!-- -->
	</a>
	<h2>Method Details</h2>
	<ul class="blockList">
	<li class="blockList">
	<section class="detail">
	<h3><a id="checkRemoteCall(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.remoteservice.IRemoteServiceRegistration,org.eclipse.ecf.remoteservice.IRemoteCall)">checkRemoteCall</a></h3>
	<div class="memberSignature"><span class="returnType">void</span> <span class="memberName">checkRemoteCall</span>(<span class="arguments"><a href="../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> fromID,
	<a href="IRemoteServiceRegistration.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceRegistration</a> registration,
	<a href="IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> remoteCall)</span>
	throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></span></div>
	<div class="block">The following method is to be called before the remote service method call to check
	if the remote service method call is authorized. Providers supporting this API
	should call any available implementing instance prior to actually
	invoking the given IRemoteCall.</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>fromID</code> - container ID of the remote caller.
	May be <code>null</code>.</dd>
	<dd><code>registration</code> - Remote service registration associated
	with the given remoteCall. Will not be <code>null</code>.</dd>
	<dd><code>remoteCall</code> - Remote method call to invoke locally (assuming this
	check passes). Will not be <code>null</code>.</dd>
	<dt><span class="throwsLabel">Throws:</span></dt>
	<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></code> - if remoteCall is not authorized for the
	given caller fromID</dd>
	</dl>
	</section>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</section>
	</div>
	<!-- ========= END OF CLASS DATA ========= -->
	</main>
	<footer role="contentinfo">
	<nav role="navigation">
	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<div class="bottomNav"><a id="navbar.bottom">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
	<a id="navbar.bottom.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../index.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="class-use/IRemoteServiceCallPolicy.html">Use</a></li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../../index-files/index-1.html">Index</a></li>
	<li><a href="../../../../help-doc.html">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.detail">Method</a></li>
	</ul>
	</div>
	</div>
	<a id="skip.navbar.bottom">
	<!-- -->
	</a>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</nav>
	<p class="legalCopy"><small>Copyright © 2004–2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p>
	</footer>
	</div>
	</div>
	</body>
	</html>