content/release-doc/current/internals/net/jini/lookup/DiscoveryAdmin.html - river-site - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (1.8.0) on Sun Aug 28 20:42:11 EST 2016 -->
 <title>DiscoveryAdmin (Apache River v3.0.0 API Documentation (internals))</title>
 <meta name="date" content="2016-08-28">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="DiscoveryAdmin (Apache River v3.0.0 API Documentation (internals))";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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";
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/DiscoveryAdmin.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-all.html">Index</a></li>
 <li><a href="../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li>Prev&nbsp;Class</li>
 <li><a href="../../../net/jini/lookup/JoinManager.html" title="class in net.jini.lookup"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../index.html?net/jini/lookup/DiscoveryAdmin.html" target="_top">Frames</a></li>
 <li><a href="DiscoveryAdmin.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <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>
 <a name="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle">net.jini.lookup</div>
 <h2 title="Interface DiscoveryAdmin" class="title">Interface DiscoveryAdmin</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Known Subinterfaces:</dt>
 <dd><a href="../../../org/apache/river/reggie/Registrar.html" title="interface in org.apache.river.reggie">Registrar</a></dd>
 </dl>
 <dl>
 <dt>All Known Implementing Classes:</dt>
 <dd><a href="../../../org/apache/river/reggie/AdminProxy.html" title="class in org.apache.river.reggie">AdminProxy</a>, <a href="../../../org/apache/river/reggie/ConstrainableAdminProxy.html" title="class in org.apache.river.reggie">ConstrainableAdminProxy</a>, <a href="../../../org/apache/river/reggie/PersistentRegistrarImpl.html" title="class in org.apache.river.reggie">PersistentRegistrarImpl</a>, <a href="../../../org/apache/river/reggie/RegistrarImpl.html" title="class in org.apache.river.reggie">RegistrarImpl</a>, <a href="../../../org/apache/river/reggie/TransientRegistrarImpl.html" title="class in org.apache.river.reggie">TransientRegistrarImpl</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public interface <span class="typeNameLabel">DiscoveryAdmin</span></pre>
 <div class="block">Methods for controlling which groups a lookup service is a member of,
  and for controlling which TCP port a lookup service uses for its
  lookup locator.  Lookup services that implement the Administrable
  interface should return an admin object that implements this interface.</div>
 <dl>
 <dt><span class="simpleTagLabel">Author:</span></dt>
 <dd>Sun Microsystems, Inc.</dd>
 </dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========== METHOD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/lookup/DiscoveryAdmin.html#addMemberGroups-java.lang.String:A-">addMemberGroups</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;groups)</code>
 <div class="block">Adds the given set of names to the set whose elements are the names
  of the groups in which the lookup service is currently a member.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/lookup/DiscoveryAdmin.html#getMemberGroups--">getMemberGroups</a></span>()</code>
 <div class="block">Returns an array consisting of the names of the groups in which the
  lookup service is a member.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/lookup/DiscoveryAdmin.html#getUnicastPort--">getUnicastPort</a></span>()</code>
 <div class="block">Returns the port number on which the lookup service listens for
  unicast discovery queries.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/lookup/DiscoveryAdmin.html#removeMemberGroups-java.lang.String:A-">removeMemberGroups</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;groups)</code>
 <div class="block">Deletes the elements of the given set of names from the set whose
  elements are the names of the groups in which the lookup service is
  currently a member.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/lookup/DiscoveryAdmin.html#setMemberGroups-java.lang.String:A-">setMemberGroups</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;groups)</code>
 <div class="block">Replaces the set whose elements are the names of the groups in which
  the lookup service is currently a member with the given set of group
  names.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/lookup/DiscoveryAdmin.html#setUnicastPort-int-">setUnicastPort</a></span>(int&nbsp;port)</code>
 <div class="block">Changes the number of the port on which the lookup service is currently
  listening for unicast discovery queries to the given port number.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="getMemberGroups--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getMemberGroups</h4>
 <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getMemberGroups()
                   throws <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
 <div class="block">Returns an array consisting of the names of the groups in which the
  lookup service is a member. If the lookup service currently belongs
  to no groups, this method will return the empty array.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd><code>String</code> array consisting of the names of the groups
          in which the lookup service is a member</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code> - typically, this exception occurs when
          there is a communication failure between the client and the
          server.</dd>
 </dl>
 </li>
 </ul>
 <a name="addMemberGroups-java.lang.String:A-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>addMemberGroups</h4>
 <pre>void&nbsp;addMemberGroups(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;groups)
               throws <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
 <div class="block">Adds the given set of names to the set whose elements are the names
  of the groups in which the lookup service is currently a member.
  Elements in the input set that duplicate names of groups in which
  the lookup service is already a member will be ignored. If the empty
  array (<code>NO_GROUPS</code>) is input, this method takes no action.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>groups</code> - <code>String</code> array consisting of the names of
                the new, additional groups in which the lookup service
                is to be a member.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code> - typically, this exception occurs when
          there is a communication failure between the client and the
          server.</dd>
 <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - this exception occurs when
          either <code>null</code> is input to the <code>groups</code>
          parameter, or one or more of the elements of the
          <code>groups</code> parameter is <code>null</code>.</dd>
 </dl>
 </li>
 </ul>
 <a name="removeMemberGroups-java.lang.String:A-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>removeMemberGroups</h4>
 <pre>void&nbsp;removeMemberGroups(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;groups)
                  throws <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
 <div class="block">Deletes the elements of the given set of names from the set whose
  elements are the names of the groups in which the lookup service is
  currently a member. Any element in the input set that is not a name
  of a group in which the lookup service is currently a member will be
  ignored. If the empty array (<code>NO_GROUPS</code>) is input, this
  method takes no action.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>groups</code> - <code>String</code> array consisting of the names to
                remove from the set whose elements are the names of the
                groups in which the lookup service is currently a member.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code> - typically, this exception occurs when
          there is a communication failure between the client and the
          server.</dd>
 <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - this exception occurs when
          either <code>null</code> is input to the <code>groups</code>
          parameter, or one or more of the elements of the
          <code>groups</code> parameter is <code>null</code>.</dd>
 </dl>
 </li>
 </ul>
 <a name="setMemberGroups-java.lang.String:A-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setMemberGroups</h4>
 <pre>void&nbsp;setMemberGroups(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;groups)
               throws <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
 <div class="block">Replaces the set whose elements are the names of the groups in which
  the lookup service is currently a member with the given set of group
  names. Elements in the input set that duplicate other elements in the
  input set will be ignored. If the empty array (<code>NO_GROUPS</code>)
  is input, then the lookup service will be a member of no groups.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>groups</code> - <code>String</code> array consisting of the names of
                the new groups in which the lookup service is to be a
                member.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code> - typically, this exception occurs when
          there is a communication failure between the client and the
          server.</dd>
 <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - this exception occurs when
          either <code>null</code> is input to the <code>groups</code>
          parameter, or one or more of the elements of the
          <code>groups</code> parameter is <code>null</code>.</dd>
 </dl>
 </li>
 </ul>
 <a name="getUnicastPort--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getUnicastPort</h4>
 <pre>int&nbsp;getUnicastPort()
             throws <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
 <div class="block">Returns the port number on which the lookup service listens for
  unicast discovery queries.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an <code>int</code> representing the port number on which the
          lookup service listens for unicast discovery queries.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code> - typically, this exception occurs when
          there is a communication failure between the client and the
          server.</dd>
 </dl>
 </li>
 </ul>
 <a name="setUnicastPort-int-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>setUnicastPort</h4>
 <pre>void&nbsp;setUnicastPort(int&nbsp;port)
              throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
                     <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
 <div class="block">Changes the number of the port on which the lookup service is currently
  listening for unicast discovery queries to the given port number.
  If a value of zero is input, then the lookup service will first try
  to listen on the standard unicast discovery port, but if that fails,
  the lookup service will listen on an arbitrary port.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>port</code> - <code>int</code> representing the new port number on which
              the lookup service should listen for unicast discovery
              queries.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - because an invocation of this method will
          result in the re-initiation of the unicast discovery process,
          which can throw an <code>IOException</code> when socket
          allocation occurs.</dd>
 <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code> - typically, this exception occurs when
          there is a communication failure between the client and the
          server.</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
 <!-- ========= END OF CLASS DATA ========= -->
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/DiscoveryAdmin.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-all.html">Index</a></li>
 <li><a href="../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li>Prev&nbsp;Class</li>
 <li><a href="../../../net/jini/lookup/JoinManager.html" title="class in net.jini.lookup"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../index.html?net/jini/lookup/DiscoveryAdmin.html" target="_top">Frames</a></li>
 <li><a href="DiscoveryAdmin.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <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>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 <p class="legalCopy"><small>Copyright 2007-2013, multiple authors.<br>Licensed under the <a href=http://www.apache.org/licenses/LICENSE-2.0 target=child >Apache License, Version 2.0</a>, see the <a href=../../../doc-files/NOTICE target=child >NOTICE</a> file for attributions.</small></p>
 </body>
 </html>