Allow an empty authType by setting it to "unknown".
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / hs / HandleEntry.java
1 /* 
2  * The Shibboleth License, Version 1. 
3  * Copyright (c) 2002 
4  * University Corporation for Advanced Internet Development, Inc. 
5  * All rights reserved
6  * 
7  * 
8  * Redistribution and use in source and binary forms, with or without 
9  * modification, are permitted provided that the following conditions are met:
10  * 
11  * Redistributions of source code must retain the above copyright notice, this 
12  * list of conditions and the following disclaimer.
13  * 
14  * Redistributions in binary form must reproduce the above copyright notice, 
15  * this list of conditions and the following disclaimer in the documentation 
16  * and/or other materials provided with the distribution, if any, must include 
17  * the following acknowledgment: "This product includes software developed by 
18  * the University Corporation for Advanced Internet Development 
19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement 
20  * may appear in the software itself, if and wherever such third-party 
21  * acknowledgments normally appear.
22  * 
23  * Neither the name of Shibboleth nor the names of its contributors, nor 
24  * Internet2, nor the University Corporation for Advanced Internet Development, 
25  * Inc., nor UCAID may be used to endorse or promote products derived from this 
26  * software without specific prior written permission. For written permission, 
27  * please contact shibboleth@shibboleth.org
28  * 
29  * Products derived from this software may not be called Shibboleth, Internet2, 
30  * UCAID, or the University Corporation for Advanced Internet Development, nor 
31  * may Shibboleth appear in their name, without prior written permission of the 
32  * University Corporation for Advanced Internet Development.
33  * 
34  * 
35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK 
39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. 
40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY 
41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, 
42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  */
49
50 package edu.internet2.middleware.shibboleth.hs;
51
52 import edu.internet2.middleware.shibboleth.*;
53 import edu.internet2.middleware.shibboleth.common.*;
54 import org.opensaml.*;
55 import java.util.*;
56 import org.doomdark.uuid.*;
57
58 /**
59  *  Object all user information is kept in
60  *
61  * @author    Barbara Jensen
62  */
63 public class HandleEntry {
64     /** opaque handle, based off MAC address and time */
65     protected String handle;
66     /** username, passed in from RemoteUser */
67     protected String username;
68     /** authentication type, passed from AuthType */
69     protected String authType;
70     /** instant of handle creation */
71     protected long authInstant;
72     /** instant of handle expiration, based on ticket length */
73     protected long expInstant;
74     
75     /**
76      *  HandleEntry object, created from HandleService
77      *
78      */
79     public HandleEntry ( String username, String authType, 
80                          long ticketLength ) 
81         throws HandleException
82     {
83         if (username == null || username.length() == 0) 
84             throw new HandleException(HandleException.ERR, "HandleEntry() requires username");
85         if (authType == null || authType.length() == 0)
86             authType = "unknown";
87
88         handle = UUIDGenerator.getInstance().generateRandomBasedUUID().toString();
89         this.username = username;
90         this.authType = authType;
91         this.authInstant= System.currentTimeMillis();
92         this.expInstant = authInstant+ticketLength;
93     }
94
95     /** 
96      *  HandleEntry object, created from all parts 
97      * 
98      */
99     public HandleEntry ( String handle, String username, String authType,
100                          long authInstant, long expInstant ) 
101         throws HandleException 
102     {
103         if (handle == null || handle.length() == 0) 
104             throw new HandleException(HandleException.ERR, "HandleEntry() requires handle");
105         if (username == null || username.length() == 0) 
106             throw new HandleException(HandleException.ERR, "HandleEntry() requires username");
107         if (authType == null || authType.length() == 0)
108             authType = "unknown";
109         
110         this.handle = handle;
111         this.username = username;
112         this.authType = authType;
113         this.authInstant = authInstant;
114         this.expInstant = expInstant;
115     }
116
117     /** 
118      *  Gets the HandleEntry's handle string 
119      * 
120      */
121     public String getHandle () {
122         return handle;
123     }
124     
125     /**
126      *  Gets the HandleEntry's username 
127      * 
128      */
129     public String getUsername () {
130         return username;
131     }
132
133     /**
134      *  Gets the HandleEntry's authentication type
135      * 
136      */
137     public String getAuthType () {
138         return authType;
139     } 
140
141     /**
142      *  Gets the HandleEntry's creation/authentication date
143      * 
144      */
145     public long getAuthInstant () {
146         return authInstant;
147     }
148
149     /**
150      *  Gets the HandleEntry's expiration date
151      * 
152      */
153     public long getExpInstant () {
154         return expInstant;
155     }
156
157 }
158