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: ArtifactResolve.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>ArtifactResolve</code> message is used to request that a SAML
037 * protocol message be returned in an <code>ArtifactResponse</code> message
038 * by specifying an artifact that represents the SAML protocol message.
039 * It has the complex type <code>ArtifactResolveType</code>.
040 * <p>
041 * <pre>
042 * &lt;complexType name="ArtifactResolveType">
043 *   &lt;complexContent>
044 *     &lt;extension base="{urn:oasis:names:tc:SAML:2.0:protocol}RequestAbstractType">
045 *       &lt;sequence>
046 *         &lt;element ref="{urn:oasis:names:tc:SAML:2.0:protocol}Artifact"/>
047 *       &lt;/sequence>
048 *     &lt;/extension>
049 *   &lt;/complexContent>
050 * &lt;/complexType>
051 * </pre>
052 *
053 * @supported.all.api
054 */
055
056public interface ArtifactResolve extends RequestAbstract {
057
058    /**
059     * Gets the <code>Artifact</code> of the request.
060     *
061     * @return <code>Artifact</code> of the request.
062     * @see #setArtifact(Artifact)
063     */
064    public Artifact getArtifact();
065
066    /**
067     * Sets the <code>Artifact</code> of the request.
068     * 
069     * @param value new <code>Artifact</code>.
070     * @throws SAML2Exception if the object is immutable.
071     * @see #getArtifact()
072     */
073    public void setArtifact(Artifact value)
074        throws SAML2Exception;
075
076}