UserAttributeStore


1   /*
2    * The Apache Software License, Version 1.1
3    *
4    * Copyright (c) 2001-2004 Caucho Technology, Inc.  All rights reserved.
5    *
6    * Redistribution and use in source and binary forms, with or without
7    * modification, are permitted provided that the following conditions
8    * are met:
9    *
10   * 1. Redistributions of source code must retain the above copyright
11   *    notice, this list of conditions and the following disclaimer.
12   *
13   * 2. Redistributions in binary form must reproduce the above copyright
14   *    notice, this list of conditions and the following disclaimer in
15   *    the documentation and/or other materials provided with the
16   *    distribution.
17   *
18   * 3. The end-user documentation included with the redistribution, if
19   *    any, must include the following acknowlegement:
20   *       "This product includes software developed by the
21   *        Caucho Technology (http://www.caucho.com/)."
22   *    Alternately, this acknowlegement may appear in the software itself,
23   *    if and wherever such third-party acknowlegements normally appear.
24   *
25   * 4. The names "Hessian", "Resin", and "Caucho" must not be used to
26   *    endorse or promote products derived from this software without prior
27   *    written permission. For written permission, please contact
28   *    info@caucho.com.
29   *
30   * 5. Products derived from this software may not be called "Resin"
31   *    nor may "Resin" appear in their names without prior written
32   *    permission of Caucho Technology.
33   *
34   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
35   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
36   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37   * DISCLAIMED.  IN NO EVENT SHALL CAUCHO TECHNOLOGY OR ITS CONTRIBUTORS
38   * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
39   * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
40   * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
41   * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
42   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
43   * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
44   * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45   *
46   * @author Sam
47   */
48  
49  package com.caucho.portal.generic;
50  
51  import javax.portlet.PortletRequest;
52  import java.io.IOException  ;
53  import java.util.Map  ;
54  import java.util.Set  ;
55  
56  /**
57   * Factory that returns a Map of user attribute values
58   * for a particular client.  The factory is used once for each
59   * connection if needed.
60   */
61  public interface UserAttributeStore {
62    /**
63     * Return a map of user attributes.  Implementing classes use the information
64     * available from <i>request</i> to determine the identity
65     * of the user.
66     *
67     * @param names a Set of names indicating the user attributes that should be
68     * returned, may be null in which case all user attributes for the
69     * user should be returned.
70     *
71     * @return a Map of attribute names to values, or null if no user attributes
72     * are available. 
73     */
74    public Map  <String  , String  > getUserAttributeMap( PortletRequest request,
75                                                    Set  <String  > names )
76      throws IOException  ;
77  
78    /**
79     * Called when a Map previously returned by getUserAttributeMap()
80     * is no longer needed. 
81     *
82     * A call to finish() is not guaranteed to occur for every Map
83     * returned by getUserAttributeMap().  If an error occurs when processing a
84     * request, the portal may not have an opportunity to call finish().
85     */
86    public void finish( Map  <String  , String  > userAttributeMap )
87      throws IOException  ;
88  }
89  
90
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags