Rationalized support for artifact lookup in the union IdP.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / artifact / ArtifactMapping.java
1 /*
2  * The Shibboleth License, Version 1. Copyright (c) 2002 University Corporation for Advanced Internet Development, Inc.
3  * All rights reserved Redistribution and use in source and binary forms, with or without modification, are permitted
4  * provided that the following conditions are met: Redistributions of source code must retain the above copyright
5  * notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above
6  * copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials
7  * provided with the distribution, if any, must include the following acknowledgment: "This product includes software
8  * developed by the University Corporation for Advanced Internet Development <http://www.ucaid.edu> Internet2 Project.
9  * Alternately, this acknowledegement may appear in the software itself, if and wherever such third-party
10  * acknowledgments normally appear. Neither the name of Shibboleth nor the names of its contributors, nor Internet2, nor
11  * the University Corporation for Advanced Internet Development, Inc., nor UCAID may be used to endorse or promote
12  * products derived from this software without specific prior written permission. For written permission, please contact
13  * shibboleth@shibboleth.org Products derived from this software may not be called Shibboleth, Internet2, UCAID, or the
14  * University Corporation for Advanced Internet Development, nor may Shibboleth appear in their name, without prior
15  * written permission of the University Corporation for Advanced Internet Development. THIS SOFTWARE IS PROVIDED BY THE
16  * COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE
18  * DISCLAIMED AND THE ENTIRE RISK OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. IN NO
19  * EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC.
20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
23  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 package edu.internet2.middleware.shibboleth.artifact;
27
28 import org.opensaml.SAMLAssertion;
29
30 import edu.internet2.middleware.shibboleth.common.ServiceProvider;
31
32 /**
33  * Encapsulates internal data/functionality that is tied to a SAML artifact.
34  * 
35  * @author Walter Hoehn
36  */
37 public class ArtifactMapping {
38
39         private String                  assertionHandle;
40         private long                    expirationTime;
41         private SAMLAssertion   assertion;
42         private String                  serviceProviderId;
43
44         public ArtifactMapping(String assertionHandle, SAMLAssertion assertion, ServiceProvider sp) {
45                 this.assertionHandle = assertionHandle;
46                 this.assertion = assertion;
47                 expirationTime = System.currentTimeMillis() + (1000 * 60 * 5); //in 5 minutes
48                 serviceProviderId = sp.getProviderId();
49         }
50
51         /**
52          * Boolean indication of whether the artifact is expired.
53          */
54         public boolean isExpired() {
55                 if (System.currentTimeMillis() > expirationTime) { return true; }
56                 return false;
57         }
58
59         /**
60          * Boolean indication of whether the artifact was created on behalf of a specified SP.
61          */
62         public boolean isCorrectProvider(ServiceProvider sp) {
63                 if (sp.getProviderId().equals(serviceProviderId)) { return true; }
64                 return false;
65         }
66
67         /**
68          * Retrieves the SAML assertion associated with the artifact.
69          */
70         public SAMLAssertion getAssertion() {
71                 return assertion;
72         }
73
74         /**
75          * Retrieves the SP on behalf of which the artifact was originally created.
76          */
77         public String getServiceProviderId() {
78                 return serviceProviderId;
79         }
80
81 }