Rationalized support for artifact lookup in the union IdP.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / artifact / provider / MemoryArtifactMapper.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.provider;
27
28 import java.util.Collections;
29 import java.util.HashMap;
30 import java.util.Map;
31
32 import org.apache.log4j.Logger;
33
34 import edu.internet2.middleware.shibboleth.artifact.ArtifactMapper;
35 import edu.internet2.middleware.shibboleth.artifact.ArtifactMapping;
36 import edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException;
37
38 /**
39  * <code>ArtifactMapper</code> implementation that saves queryable artifacts in memory.
40  * 
41  * @author Walter Hoehn
42  */
43 public class MemoryArtifactMapper extends BaseArtifactMapper implements ArtifactMapper {
44
45         public MemoryArtifactMapper() throws ShibbolethConfigurationException {
46                 super();
47         }
48
49         //TODO need to cleanup stale artifacts
50         private static Logger   log                     = Logger.getLogger(MemoryArtifactMapper.class.getName());
51         private static Map              mappings        = Collections.synchronizedMap(new HashMap());
52
53         /*
54          * (non-Javadoc)
55          * 
56          * @see edu.internet2.middleware.shibboleth.artifact.provider.BaseArtifactMapper#recoverAssertionImpl(java.lang.String)
57          */
58         protected ArtifactMapping recoverAssertionImpl(String stringHandle) {
59
60                 //Load the assertion from memory
61                 ArtifactMapping mapping = (ArtifactMapping) mappings.get(stringHandle);
62                 mappings.remove(stringHandle);
63                 if (mapping == null || mapping.isExpired()) { return null; }
64                 return mapping;
65         }
66
67         /*
68          * (non-Javadoc)
69          * 
70          * @see edu.internet2.middleware.shibboleth.artifact.provider.BaseArtifactMapper#addAssertionImpl(java.lang.String,
71          *      edu.internet2.middleware.shibboleth.artifact.ArtifactMapping)
72          */
73         protected void addAssertionImpl(String assertionHandle, ArtifactMapping mapping) {
74                 mappings.put(assertionHandle, mapping);
75         }
76
77 }