1 /* 2 * Copyright [2007] [University Corporation for Advanced Internet Development, Inc.] 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package org.opensaml.saml2.binding; 18 19 import org.opensaml.common.SAMLObject; 20 import org.opensaml.common.binding.SAMLMessageContext; 21 22 /** 23 * Extensions to the base SAML message context that carries artifact related information. 24 * 25 * @param <InboundMessageType> type of inbound SAML message 26 * @param <OutboundMessageType> type of outbound SAML message 27 * @param <NameIdentifierType> type of name identifier used for subjects 28 */ 29 public interface SAML2ArtifactMessageContext<InboundMessageType extends SAMLObject, OutboundMessageType extends SAMLObject, NameIdentifierType extends SAMLObject> 30 extends SAMLMessageContext<InboundMessageType, OutboundMessageType, NameIdentifierType> { 31 32 /** 33 * Gets the Base64-encoded artifact to be resolved. 34 * 35 * @return artifact to be resolved 36 */ 37 public String getArtifact(); 38 39 /** 40 * Sets the Base64-encoded artifact to be resolved. 41 * 42 * @param artifact artifact to be resolved 43 */ 44 public void setArtifact(String artifact); 45 46 /** 47 * Gets the SAML message referenced by the artifact. 48 * 49 * @return SAML message referenced by the artifact 50 */ 51 public SAMLObject getReferencedMessage(); 52 53 /** 54 * Sets the SAML message referenced by the artifact. 55 * 56 * @param message SAML message referenced by the artifact 57 */ 58 public void setReferencedMessage(SAMLObject message); 59 }