KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jacorb > orb > portableInterceptor > IORInfoExt


1 /*
2  * JacORB - a free Java ORB
3  *
4  * Copyright (C) 1999-2004 Gerald Brose
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the Free
18  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19  *
20  */
21
22 package org.jacorb.orb.portableInterceptor;
23
24 import org.omg.PortableInterceptor.IORInfo JavaDoc;
25
26 /**
27  * This class extends the standard defined interface of the IORInfo
28  * object given to each IORInterceptor during creation of new IORs.
29  * It provides convenience methods to modify the newly created IOR.
30
31  * @author Marc Heide
32  * @version $Id: IORInfoExt.java,v 1.3 2004/05/06 12:40:00 nicolas Exp $
33  */
34
35 public interface IORInfoExt extends IORInfo JavaDoc
36 {
37    /**
38     * This method adds a further profile to an IOR.
39     * By using this method it is possible to append e.g. further IIOP
40     * profiles. The added profile is marshalled after all profiles
41     * already existing in profile list.
42     * @param profile the profile to add
43     */
44    public void add_profile(org.omg.ETF.Profile profile);
45
46    /**
47     * This method returns the number of profiles of the given type.
48     * The returned value can be used to iterate over the existing
49     * profiles of given type (get_profile()).
50     * @param tag profile tag, e.g. TAG_INTERNET_IOP.value
51     * @return number of profiles of given tag
52     */
53    public int get_number_of_profiles(int tag);
54
55    /**
56     * Returns the profile with the given tag at the given position.
57     * Following rule must apply to parameter position:<p>
58     * <code> 0 <= position < get_number_of_profiles(tag) </code><p>
59     * @param tag tag of profile, e.g. TAG_INTERNET_IOP.value
60     * @param position position in IOR
61     * @return profile
62     * @exception ArrayIndexOutOfBoundsException if position is
63     * out of range
64     */
65    public org.omg.ETF.Profile get_profile(int tag, int position);
66
67    /**
68     * Returns the first profile with the given tag (position == 0).
69     * If no profile with given tag exists, null is returned.
70     * @param tag tag of profile, e.g. TAG_INTERNET_IOP.value
71     * @return first profile or null if no profile with given
72     * tag exists
73     */
74    public org.omg.ETF.Profile get_profile(int tag);
75 }
76
Popular Tags