src/edu/internet2/middleware/shibboleth/common/RelyingParty.java

   1 /*
   2  * The Shibboleth License, Version 1. Copyright (c) 2002 University Corporation for Advanced Internet Development, Inc.
   3  * All rights reserved
   4  *
   5  *
   6  * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
   7  * following conditions are met:
   8  *
   9  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following
  10  * disclaimer.
  11  *
  12  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
  13  * disclaimer in the documentation and/or other materials provided with the distribution, if any, must include the
  14  * following acknowledgment: "This product includes software developed by the University Corporation for Advanced
  15  * Internet Development <http://www.ucaid.edu> Internet2 Project. Alternately, this acknowledegement may appear in the
  16  * software itself, if and wherever such third-party acknowledgments normally appear.
  17  *
  18  * Neither the name of Shibboleth nor the names of its contributors, nor Internet2, nor the University Corporation for
  19  * Advanced Internet Development, Inc., nor UCAID may be used to endorse or promote products derived from this software
  20  * without specific prior written permission. For written permission, please contact shibboleth@shibboleth.org
  21  *
  22  * Products derived from this software may not be called Shibboleth, Internet2, UCAID, or the University Corporation
  23  * for Advanced Internet Development, nor may Shibboleth appear in their name, without prior written permission of the
  24  * University Corporation for Advanced Internet Development.
  25  *
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITH ALL FAULTS. ANY EXPRESS OR
  28  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  29  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK OF SATISFACTORY QUALITY, PERFORMANCE,
  30  * ACCURACY, AND EFFORT IS WITH LICENSEE. IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY
  31  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  32  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  33  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  35  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 package edu.internet2.middleware.shibboleth.common;
  39
  40 /**
  41  * Defines a relationship between service providers and an identity provider. In Shibboleth parlance, a relying party
  42  * represents a target or federation.
  43  *
  44  * @author Walter Hoehn
  45  */
  46 public interface RelyingParty extends ServiceProvider {
  47
  48         /**
  49          * Returns the name of the relying party. If the relying party is a Shibboleth target (not a federation), this
  50          * function returns the same thing as {@link #getProviderId}.
  51          *
  52          * @return name of the relying party
  53          */
  54         public String getName();
  55
  56         /**
  57          * Returns the appropriate identity provider to create assertions for this relying party.
  58          *
  59          * @return the identity provider
  60          */
  61         public IdentityProvider getIdentityProvider();
  62 }