1 /*
   2  * Copyright (c) 2002, 2003, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.corba.se.spi.ior;
  27 
  28 import com.sun.corba.se.spi.orb.ORB ;
  29 
  30 /** TaggedProfile represents a tagged profile in an IOR.
  31  * A profile contains all of the information necessary for an invocation.
  32  * It contains one or more endpoints that may be used for an invocation.
  33  * A TaggedProfile conceptually has three parts: A TaggedProfileTemplate,
  34  * an ObjectKeyTemplate, and an ObjectId.
  35  */
  36 public interface TaggedProfile extends Identifiable, MakeImmutable
  37 {
  38     TaggedProfileTemplate getTaggedProfileTemplate() ;
  39 
  40     ObjectId getObjectId() ;
  41 
  42     ObjectKeyTemplate getObjectKeyTemplate() ;
  43 
  44     ObjectKey getObjectKey() ;
  45 
  46     /** Return true is prof is equivalent to this TaggedProfile.
  47      * This means that this and prof are indistinguishable for
  48      * the purposes of remote invocation.  Typically this means that
  49      * the profile data is identical and both profiles contain exactly
  50      * the same components (if components are applicable).
  51      * isEquivalent( prof ) should imply that getObjectId().equals(
  52      * prof.getObjectId() ) is true, and so is
  53      * getObjectKeyTemplate().equals( prof.getObjectKeyTemplate() ).
  54      */
  55     boolean isEquivalent( TaggedProfile prof ) ;
  56 
  57     /** Return the TaggedProfile as a CDR encapsulation in the standard
  58      * format.  This is required for Portable interceptors.
  59      */
  60     org.omg.IOP.TaggedProfile getIOPProfile();
  61 
  62     /** Return true if this TaggedProfile was created in orb.
  63      *  Caches the result.
  64      */
  65     boolean isLocal() ;
  66 }