IORFactory.java

/*
 * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package org.jboss.com.sun.corba.se.spi.ior;

import org.jboss.com.sun.corba.se.spi.orb.ORB;

/**
 * An IORFactory provides the capability of creating IORs. It contains some collection of TaggedProfileTemplates, which
 * can be iterated over for portable interceptors.
 */
public interface IORFactory extends Writeable, MakeImmutable
{
    /**
     * Construct an IOR containing the given ORB, typeid, and ObjectId. The same ObjectId will be used for all
     * TaggedProfileTemplates in the IORFactory.
     */
    IOR makeIOR(ORB orb, String typeid, ObjectId oid);

    /**
     * Return true iff this.makeIOR(orb,typeid,oid).isEquivalent( other.makeIOR(orb,typeid,oid) for all orb, typeid, and
     * oid.
     */
    boolean isEquivalent(IORFactory other);
}