View Javadoc

1   /* 
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8   *
9   *     http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17  
18  /*Created on: Nov 23, 2005 */
19  
20  package org.apache.jetspeed.sso;
21  
22  import java.sql.Timestamp;
23  import java.util.Collection;
24  
25  /***
26   * Interface SSOCookie
27   * 
28   * @author Roger Ruttimann <rogerrut@apache.org>
29   * 
30   * Class sthat handles the cookies created for SSO
31   * principals
32   *
33   */
34  public interface SSOCookie {
35  
36  	/*** Setters and getters for cookie properties */
37  	
38  	/***
39  	 * 
40  	 * @param cookieId
41  	 */
42  	void setCookieId(int cookieId);
43  	/***
44  	 * 
45  	 * @return
46  	 */
47  	int	getCookieId();
48  	
49  	/***
50  	 * 
51  	 * @param cookieValue
52  	 */
53  	void setCookie(String cookieValue);
54  	/***
55  	 * 
56  	 * @return
57  	 */
58  	String getCookie();
59  	
60  	/***
61  	 * 
62  	 * @param createDate
63  	 */
64  	void setCreateDate(Timestamp createDate);
65  	/***
66  	 * 
67  	 * @return
68  	 */
69  	Timestamp getCreateDate();
70  	
71  	/***
72  	 * 
73  	 * @return
74  	 */
75  	Collection getRemotePrincipals();
76  	
77  	/***
78  	 * 
79  	 * @param remotePrincipals
80  	 */
81  	void setRemotePrincipals(Collection remotePrincipals);
82  }