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: RequestedAuthnContext.java,v 1.2 2008/06/25 05:47:57 qcheng Exp $ 026 * 027 */ 028 029 030package com.sun.identity.saml2.protocol; 031 032import java.util.List; 033 034import org.w3c.dom.Element; 035 036import com.sun.identity.saml2.common.SAML2Exception; 037 038/** 039 * Java content class for RequestedAuthnContext element declaration. 040 * <p>The following schema fragment specifies the expected 041 * content contained within this java content object. 042 * <p> 043 * <pre> 044 * <element name="RequestedAuthnContext" type="{urn:oasis:names:tc:SAML:2.0:protocol}RequestedAuthnContextType"/> 045 * </pre> 046 * 047 * @supported.all.api 048 */ 049public interface RequestedAuthnContext { 050 051 /** 052 * Returns list of authentication context class references. References 053 * in the list is String object. 054 * 055 * @return list of authentication context class references. 056 */ 057 List getAuthnContextClassRef(); 058 059 /** 060 * Sets authentication context class references. 061 * 062 * @param references List of authentication context class references where 063 * references in the list is String object. 064 * @throws SAML2Exception if this object is immutable. 065 */ 066 void setAuthnContextClassRef(List references) 067 throws SAML2Exception; 068 069 /** 070 * Returns list of authentication context declaration class references. 071 * References in the list is String object. 072 * 073 * @return list of authentication context declaration class references. 074 */ 075 List getAuthnContextDeclRef(); 076 077 /** 078 * Sets authentication context declaration class references. 079 * 080 * @param references List of authentication context declaration class 081 * references where references in the list is String object. 082 * @throws SAML2Exception if this object is immutable. 083 */ 084 void setAuthnContextDeclRef(List references) throws SAML2Exception; 085 086 /** 087 * Returns the value of <code>Comparison</code> property. 088 * 089 * @return the value of <code>Comparison</code> property. 090 */ 091 String getComparison(); 092 093 /** 094 * Sets the value of the <code>Comparison</code> property. 095 * 096 * @param value the value of the <code>Comparison</code> property. 097 * @throws SAML2Exception if <code>Object</code> is immutable. 098 */ 099 void setComparison(String value) throws SAML2Exception; 100 101 /** 102 * Returns a String representation of this Object. 103 * 104 * @return a String representation of this Object. 105 * @throws SAML2Exception if it failed to pasrse the object. 106 */ 107 String toXMLString() throws SAML2Exception; 108 109 /** 110 * Returns a String representation of this Object. 111 * 112 * @param includeNSPrefix true to prepend the namespace qualifier 113 * to the Element. 114 * @param declareNS true to declare the namespace within the Element. 115 * @return the String representation of this Object. 116 * @throws SAML2Exception if it failed to pasrse the object. 117 */ 118 String toXMLString(boolean includeNSPrefix, boolean declareNS) 119 throws SAML2Exception; 120 121 /** 122 * Makes this object immutable by making this object unmodifiable. 123 */ 124 void makeImmutable() ; 125 126 /** 127 * Returns true if mutable, false otherwise. 128 * 129 * @return true if mutable, false otherwise. 130 */ 131 boolean isMutable(); 132}