View Javadoc

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.saml1.binding;
18  
19  import java.util.Collection;
20  
21  import org.opensaml.common.SAMLObject;
22  import org.opensaml.common.binding.SAMLMessageContext;
23  import org.opensaml.saml1.core.Assertion;
24  
25  /**
26   * Extensions to the base SAML message context that carries artifact related information.
27   * 
28   * @param <InboundMessageType> type of inbound SAML message
29   * @param <OutboundMessageType> type of outbound SAML message
30   * @param <NameIdentifierType> type of name identifier used for subjects
31   */
32  public interface SAML1ArtifactMessageContext<InboundMessageType extends SAMLObject, OutboundMessageType extends SAMLObject, NameIdentifierType extends SAMLObject>
33          extends SAMLMessageContext<InboundMessageType, OutboundMessageType, NameIdentifierType> {
34  
35      /**
36       * Gets the Base64 encoded artifacts to be resolved.
37       * 
38       * @return artifacts to be resolved
39       */
40      public Collection<String> getArtifacts();
41  
42      /**
43       * Sets the Base64 encoded artifacts to be resolved.
44       * 
45       * @param artifacts artifacts to be resolved
46       */
47      public void setArtifacts(Collection<String> artifacts);
48  
49      /**
50       * Gets the assertions dereferenced from the artifacts.
51       * 
52       * @return assertions dereferenced from the artifacts
53       */
54      public Collection<Assertion> getDereferencedAssertions();
55  
56      /**
57       * Sets the assertions dereferenced from the artifacts.
58       * 
59       * @param assertions assertions dereferenced from the artifacts
60       */
61      public void setDereferencedAssertions(Collection<Assertion> assertions);
62  }