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