001/** 002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. 003 * 004 * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved 005 * 006 * The contents of this file are subject to the terms 007 * of the Common Development and Distribution License 008 * (the License). You may not use this file except in 009 * compliance with the License. 010 * 011 * You can obtain a copy of the License at 012 * https://opensso.dev.java.net/public/CDDLv1.0.html or 013 * opensso/legal/CDDLv1.0.txt 014 * See the License for the specific language governing 015 * permission and limitations under the License. 016 * 017 * When distributing Covered Code, include this CDDL 018 * Header Notice in each file and include the License file 019 * at opensso/legal/CDDLv1.0.txt. 020 * If applicable, add the following below the CDDL Header, 021 * with the fields enclosed by brackets [] replaced by 022 * your own identifying information: 023 * "Portions Copyrighted [year] [name of copyright owner]" 024 * 025 * $Id: BaseIDAbstract.java,v 1.2 2008/06/25 05:47:40 qcheng Exp $ 026 * 027 */ 028 029 030package com.sun.identity.saml2.assertion; 031 032import com.sun.identity.saml2.common.SAML2Exception; 033 034/** 035 * The <code>BaseIDAbstract</code> is an abstract type usable only as 036 * the base of a derived type. It includes the following attributes 037 * for use by extended identifier representations: 038 * <code>NameQualifier</code> [optional] 039 * The security or administrative domain that qualifies the identifier. 040 * This attribute provides a means to federate identifiers from 041 * disparate user data stores without collision. 042 * <code>SPNameQualifier</code> [optional] 043 * Further qualifies an identifier with the name of a service provider 044 * or affiliation of providers. This attribute provides an additional 045 * means to federate identifiers on the basis of the relying party 046 * or parties. 047 * @supported.all.api 048 */ 049public interface BaseIDAbstract { 050 051 /** 052 * Returns the name qualifier 053 * 054 * @return the name qualifier 055 */ 056 public String getNameQualifier(); 057 058 /** 059 * Sets the name qualifier 060 * 061 * @param nameQualifier the name qualifier 062 * @exception SAML2Exception if the object is immutable 063 */ 064 public void setNameQualifier(String nameQualifier) 065 throws SAML2Exception; 066 067 /** 068 * Returns the <code>SP</code> name qualifier 069 * 070 * @return the <code>SP</code> name qualifier 071 */ 072 public String getSPNameQualifier(); 073 074 /** 075 * Sets the <code>SP</code> name qualifier 076 * 077 * @param spNameQualifier the <code>SP</code> name qualifier 078 * @exception SAML2Exception if the object is immutable 079 */ 080 public void setSPNameQualifier(String spNameQualifier) 081 throws SAML2Exception; 082 083 /** 084 * Makes the object immutable 085 */ 086 public void makeImmutable(); 087 088 /** 089 * Returns true if the object is mutable 090 * 091 * @return true if the object is mutable 092 */ 093 public boolean isMutable(); 094 095}
Copyright © 2010-2017, ForgeRock All Rights Reserved.