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 */ 028 029 030 031package com.sun.identity.saml2.protocol; 032 033import com.sun.identity.saml2.common.SAML2Exception; 034 035/** 036 * The <code>ArtifactResopnse</code> message has the complex type 037 * <code>ArtifactResponseType</code>. 038 * <p> 039 * <pre> 040 * <complexType name="ArtifactResponseType"> 041 * <complexContent> 042 * <extension base="{urn:oasis:names:tc:SAML:2.0:protocol}StatusResponseType"> 043 * <sequence> 044 * <any/> 045 * </sequence> 046 * </extension> 047 * </complexContent> 048 * </complexType> 049 * </pre> 050 * 051 * @supported.all.api 052 */ 053 054public interface ArtifactResponse extends StatusResponse { 055 056 /** 057 * Gets the <code>any</code> element of the response. 058 * 059 * @return <code>any</code> element in xml string format. 060 * @see #setAny(String) 061 */ 062 public String getAny(); 063 064 /** 065 * Sets the <code>any</code> element of the response. 066 * 067 * @param value new <code>any</code> element in xml string format. 068 * @throws SAML2Exception if the object is immutable. 069 * @see #getAny() 070 */ 071 public void setAny(String value) 072 throws SAML2Exception; 073 074}