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.artifact;
18  
19  import org.opensaml.common.binding.SAMLMessageContext;
20  import org.opensaml.saml1.core.Assertion;
21  import org.opensaml.saml1.core.NameIdentifier;
22  import org.opensaml.saml1.core.RequestAbstractType;
23  import org.opensaml.saml1.core.Response;
24  
25  /**
26   * Builder of typed SAML 1 artifacts.
27   * 
28   * Builders must be thread safe and reusable.
29   * 
30   * @param <ArtifactType> type of artifact built by this builder
31   */
32  public interface SAML1ArtifactBuilder<ArtifactType extends AbstractSAML1Artifact> {
33  
34      /**
35       * Builds an artifact, for the given assertion, destined for the outbound message recipient.
36       * 
37       * @param requestContext request context
38       * @param assertion assertion to build artifact for
39       * 
40       * @return constructed artifcate
41       */
42      public ArtifactType buildArtifact(SAMLMessageContext<RequestAbstractType, Response, NameIdentifier> requestContext,
43              Assertion assertion);
44  
45      /**
46       * Builds a populated artifact given the artifact's byte-array representation.
47       * 
48       * @param artifact the byte representation of the artifact
49       * 
50       * @return populated artifact
51       */
52      public ArtifactType buildArtifact(byte[] artifact);
53  
54  }