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 * Portions Copyrighted 2016 ForgeRock AS. 028 */ 029 030 031package com.sun.identity.saml2.protocol; 032 033import com.fasterxml.jackson.annotation.JsonTypeInfo; 034import com.sun.identity.saml2.common.SAML2Exception; 035import com.sun.identity.saml2.protocol.impl.RequestedAuthnContextImpl; 036import java.util.List; 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 */ 049 050@JsonTypeInfo(include = JsonTypeInfo.As.PROPERTY, use = JsonTypeInfo.Id.CLASS, 051 defaultImpl = RequestedAuthnContextImpl.class) 052public interface RequestedAuthnContext { 053 054 /** 055 * Returns list of authentication context class references. References 056 * in the list is String object. 057 * 058 * @return list of authentication context class references. 059 */ 060 List<String> getAuthnContextClassRef(); 061 062 /** 063 * Sets authentication context class references. 064 * 065 * @param references List of authentication context class references where 066 * references in the list is String object. 067 * @throws SAML2Exception if this object is immutable. 068 */ 069 void setAuthnContextClassRef(List references) 070 throws SAML2Exception; 071 072 /** 073 * Returns list of authentication context declaration class references. 074 * References in the list is String object. 075 * 076 * @return list of authentication context declaration class references. 077 */ 078 List getAuthnContextDeclRef(); 079 080 /** 081 * Sets authentication context declaration class references. 082 * 083 * @param references List of authentication context declaration class 084 * references where references in the list is String object. 085 * @throws SAML2Exception if this object is immutable. 086 */ 087 void setAuthnContextDeclRef(List references) throws SAML2Exception; 088 089 /** 090 * Returns the value of <code>Comparison</code> property. 091 * 092 * @return the value of <code>Comparison</code> property. 093 */ 094 String getComparison(); 095 096 /** 097 * Sets the value of the <code>Comparison</code> property. 098 * 099 * @param value the value of the <code>Comparison</code> property. 100 * @throws SAML2Exception if <code>Object</code> is immutable. 101 */ 102 void setComparison(String value) throws SAML2Exception; 103 104 /** 105 * Returns a String representation of this Object. 106 * 107 * @return a String representation of this Object. 108 * @throws SAML2Exception if it failed to pasrse the object. 109 */ 110 String toXMLString() throws SAML2Exception; 111 112 /** 113 * Returns a String representation of this Object. 114 * 115 * @param includeNSPrefix true to prepend the namespace qualifier 116 * to the Element. 117 * @param declareNS true to declare the namespace within the Element. 118 * @return the String representation of this Object. 119 * @throws SAML2Exception if it failed to pasrse the object. 120 */ 121 String toXMLString(boolean includeNSPrefix, boolean declareNS) 122 throws SAML2Exception; 123 124 /** 125 * Makes this object immutable by making this object unmodifiable. 126 */ 127 void makeImmutable() ; 128 129 /** 130 * Returns true if mutable, false otherwise. 131 * 132 * @return true if mutable, false otherwise. 133 */ 134 boolean isMutable(); 135}