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