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: ArtifactResponse.java,v 1.2 2008/06/25 05:47:56 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.ArtifactResponseImpl; 037 038/** 039 * The <code>ArtifactResopnse</code> message has the complex type 040 * <code>ArtifactResponseType</code>. 041 * <p> 042 * <pre> 043 * <complexType name="ArtifactResponseType"> 044 * <complexContent> 045 * <extension base="{urn:oasis:names:tc:SAML:2.0:protocol}StatusResponseType"> 046 * <sequence> 047 * <any/> 048 * </sequence> 049 * </extension> 050 * </complexContent> 051 * </complexType> 052 * </pre> 053 * 054 * @supported.all.api 055 */ 056 057@JsonTypeInfo(include = JsonTypeInfo.As.PROPERTY, use = JsonTypeInfo.Id.CLASS, 058 defaultImpl = ArtifactResponseImpl.class) 059public interface ArtifactResponse extends StatusResponse { 060 061 /** 062 * Gets the <code>any</code> element of the response. 063 * 064 * @return <code>any</code> element in xml string format. 065 * @see #setAny(String) 066 */ 067 public String getAny(); 068 069 /** 070 * Sets the <code>any</code> element of the response. 071 * 072 * @param value new <code>any</code> element in xml string format. 073 * @throws SAML2Exception if the object is immutable. 074 * @see #getAny() 075 */ 076 public void setAny(String value) 077 throws SAML2Exception; 078 079}