| Frames | No Frames |
1: /* NamingContext.java -- 2: Copyright (C) 2005 Free Software Foundation, Inc. 3: 4: This file is part of GNU Classpath. 5: 6: GNU Classpath is free software; you can redistribute it and/or modify 7: it under the terms of the GNU General Public License as published by 8: the Free Software Foundation; either version 2, or (at your option) 9: any later version. 10: 11: GNU Classpath is distributed in the hope that it will be useful, but 12: WITHOUT ANY WARRANTY; without even the implied warranty of 13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14: General Public License for more details. 15: 16: You should have received a copy of the GNU General Public License 17: along with GNU Classpath; see the file COPYING. If not, write to the 18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19: 02110-1301 USA. 20: 21: Linking this library statically or dynamically with other modules is 22: making a combined work based on this library. Thus, the terms and 23: conditions of the GNU General Public License cover the whole 24: combination. 25: 26: As a special exception, the copyright holders of this library give you 27: permission to link this library with independent modules to produce an 28: executable, regardless of the license terms of these independent 29: modules, and to copy and distribute the resulting executable under 30: terms of your choice, provided that you also meet, for each linked 31: independent module, the terms and conditions of the license of that 32: module. An independent module is a module which is not derived from 33: or based on this library. If you modify this library, you may extend 34: this exception to your version of the library, but you are not 35: obligated to do so. If you do not wish to do so, delete this 36: exception statement from your version. */ 37: 38: 39: package org.omg.CosNaming; 40: 41: import org.omg.CORBA.portable.IDLEntity; 42: import org.omg.CosNaming.NamingContextPackage.AlreadyBound; 43: import org.omg.CosNaming.NamingContextPackage.CannotProceed; 44: import org.omg.CosNaming.NamingContextPackage.InvalidName; 45: import org.omg.CosNaming.NamingContextPackage.NotEmpty; 46: import org.omg.CosNaming.NamingContextPackage.NotFound; 47: 48: /** 49: * The interface for the naming context. The naming context can 50: * store (bound) and retrieve (resolve) the named objects or 51: * named child contexts. These operations are defined in a separate 52: * interface. 53: * 54: * @see NamingContextExt 55: * 56: * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org) 57: */ 58: public interface NamingContext 59: extends NamingContextOperations, org.omg.CORBA.Object, IDLEntity 60: { 61: /** 62: * Gives the object a name, valid in this context. 63: * 64: * @param a_name the name, being given to the object. 65: * @param an_object the object, being named. 66: * 67: * @throws AlreadyBound if the object is already named in this context. 68: * @throws InvalidName if the name has zero length or otherwise invalid. 69: * 70: * @specnote since 1.3 this method has moved into NamingContextOperations. 71: */ 72: void bind(NameComponent[] a_name, org.omg.CORBA.Object an_object) 73: throws NotFound, CannotProceed, InvalidName, AlreadyBound; 74: 75: /** 76: * Gives a child context name, valid in this context. 77: * 78: * @param a_name the name, being given to the child context. 79: * @param a_context the child context being named. 80: * 81: * @throws AlreadyBound if the child context is already named in 82: * the current context. 83: * 84: * @specnote since 1.3 this method has moved into NamingContextOperations. 85: */ 86: void bind_context(NameComponent[] a_name, NamingContext a_context) 87: throws NotFound, CannotProceed, InvalidName, AlreadyBound; 88: 89: /** 90: * Create a new context and give it a given name (bound it) 91: * in the current context. 92: * 93: * @param a_name the name being given to the new context. 94: * 95: * @return the newly created context. 96: * 97: * @throws AlreadyBound if the name is already in use. 98: * @throws InvalidName if the name has zero length or otherwise invalid. 99: * 100: * @specnote since 1.3 this method has moved into NamingContextOperations. 101: */ 102: NamingContext bind_new_context(NameComponent[] a_name) 103: throws NotFound, AlreadyBound, CannotProceed, 104: InvalidName; 105: 106: /** 107: * Destroy this context (must be empty). 108: * @throws NotEmpty if the context being destroyed is not empty. 109: * 110: * @specnote since 1.3 this method has moved into NamingContextOperations. 111: */ 112: void destroy() 113: throws NotEmpty; 114: 115: /** 116: * Iterate over all bindings, defined in this namind context. 117: * 118: * @param amount the maximal number of context to return in the 119: * holder a_list. The remaining bindings are accessible via iterator 120: * an_iter. If the parameter amount is zero, all bindings are accessed only 121: * via this iterator. 122: * 123: * @param a_list the holder, where the returned bindigs are stored. 124: * @param an_iter the iterator that can be used to access the remaining 125: * bindings. 126: * 127: * @specnote since 1.3 this method has moved into NamingContextOperations. 128: */ 129: void list(int amount, BindingListHolder a_list, BindingIteratorHolder an_iter); 130: 131: /** 132: * Creates a new naming context, not bound to any name. 133: * 134: * @specnote since 1.3 this method has moved into NamingContextOperations. 135: */ 136: NamingContext new_context(); 137: 138: /** 139: * Names or renames the object. 140: * 141: * @param a_name the new name, being given to the object. If 142: * the object is already named in this context, it is renamed. 143: * 144: * @param an_object the object, being named. 145: * 146: * @throws InvalidName if the name has zero length or otherwise invalid. 147: * 148: * @specnote since 1.3 this method has moved into NamingContextOperations. 149: */ 150: void rebind(NameComponent[] a_name, org.omg.CORBA.Object an_object) 151: throws NotFound, CannotProceed, InvalidName; 152: 153: /** 154: * Names or renames the child context. 155: * If the child context is already named in 156: * the current context, it is renamed. 157: * 158: * @param a_name the name, being given to the child context. 159: * @param a_context the child context being named. 160: * 161: * @throws InvalidName if the name has zero length or otherwise invalid. 162: * 163: * @specnote since 1.3 this method has moved into NamingContextOperations. 164: */ 165: void rebind_context(NameComponent[] a_name, NamingContext a_context) 166: throws NotFound, CannotProceed, InvalidName; 167: 168: /** 169: * Get the object, bound to the specified name in this 170: * context. 171: * 172: * @param a_name the object name. 173: * 174: * @return the object, matching this name. The client 175: * usually casts or narrows (using the helper) the returned value 176: * to the more specific type. 177: * 178: * @throws NotFound 179: * @throws InvalidName if the name has zero length or otherwise invalid. 180: * 181: * @specnote since 1.3 this method has moved into NamingContextOperations. 182: */ 183: org.omg.CORBA.Object resolve(NameComponent[] a_name) 184: throws NotFound, CannotProceed, InvalidName; 185: 186: /** 187: * Removes the name from the binding context. 188: * 189: * @param a_name a name to remove. 190: * 191: * @throws InvalidName if the name has zero length or otherwise invalid. 192: * 193: * @specnote since 1.3 this method has moved into NamingContextOperations. 194: */ 195: void unbind(NameComponent[] a_name) 196: throws NotFound, CannotProceed, InvalidName; 197: }