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: Response.java,v 1.2 2008/06/25 05:47:57 qcheng Exp $ 026 * 027 */ 028 029 030 031package com.sun.identity.saml2.protocol; 032 033import java.util.List; 034import com.sun.identity.saml2.common.SAML2Exception; 035 036/** 037 * The <code>Response</code> message element is used when a response consists 038 * of a list of zero or more assertions that satisfy the request. It has the 039 * complex type <code>ResponseType</code>. 040 * <p> 041 * <pre> 042 * <complexType name="ResponseType"> 043 * <complexContent> 044 * <extension base="{urn:oasis:names:tc:SAML:2.0:protocol}StatusResponseType"> 045 * <choice maxOccurs="unbounded" minOccurs="0"> 046 * <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}Assertion"/> 047 * <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}EncryptedAssertion"/> 048 * </choice> 049 * </extension> 050 * </complexContent> 051 * </complexType> 052 * </pre> 053 * 054 * @supported.all.api 055 */ 056public interface Response extends StatusResponse { 057 058 /** 059 * Returns <code>Assertion</code>(s) of the response. 060 * 061 * @return List of <code>Assertion</code>(s) in the response. 062 * @see #setAssertion(List) 063 */ 064 public List getAssertion(); 065 066 /** 067 * Sets Assertion(s) of the response. 068 * 069 * @param value List of new <code>Assertion</code>(s). 070 * @throws SAML2Exception if the object is immutable. 071 * @see #getAssertion() 072 */ 073 public void setAssertion(List value) 074 throws SAML2Exception; 075 076 /** 077 * Returns <code>EncryptedAssertion</code>(s) of the response. 078 * 079 * @return List of <code>EncryptedAssertion</code>(s) in the response. 080 * @see #setEncryptedAssertion(List) 081 */ 082 public List getEncryptedAssertion(); 083 084 /** 085 * Sets <code>EncryptedAssertion</code>(s) of the response. 086 * 087 * @param value List of new <code>EncryptedAssertion</code>(s). 088 * @throws SAML2Exception if the object is immutable. 089 * @see #getEncryptedAssertion() 090 */ 091 public void setEncryptedAssertion(List value) 092 throws SAML2Exception; 093 094}
Copyright © 2010-2017, ForgeRock All Rights Reserved.