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