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  package org.apache.jetspeed.security.activeauthentication;
18  
19  import java.util.Iterator;
20  
21  
22  /***
23   * <p>
24   * Identity Token
25   * </p>
26   * <p>
27   * Holds a unique token identifying the current authentication process.  
28   * This token can hold one or more unique name / value (object) attributes
29   * </p>
30   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
31   * @version $Id: $
32   *
33   */
34  public interface IdentityToken
35  {
36      /***
37       * Get the value of the identity token 
38       * @return the identity token string
39       */
40      String getToken();
41      
42      /***
43       * set a name/value attribute on this token
44       * @param name
45       * @param value
46       */
47      void setAttribute(String name, Object value);
48      
49      /*** 
50       * Get an attribute value given the attribute name
51       * @param name
52       * @return
53       */
54      Object getAttribute(String name);
55      
56      /***
57       * Get an iterator over all attribute names
58       * @return
59       */
60      Iterator getAttributeNames();
61  }