1 /*
2 * Copyright (c) 2002-2014, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.mylutece.modules.oauth.authentication;
35
36 import fr.paris.lutece.portal.service.security.LuteceUser;
37
38 import java.util.HashMap;
39 import java.util.Map;
40
41
42 /**
43 *
44 * AbstractOAuthCredentialsRetriever.
45 * <br>
46 * Set the tags map to enhance info parsing.
47 * Keys of the map is {@link LuteceUser} properties, values are tag that should be looked for.
48 * @see #DEFAULT_TAGS
49 * @see LuteceUser#NAME_FAMILY
50 */
51 public abstract class AbstractOAuthCredentialsRetriever implements IOAuthCredentialsRetriever
52 {
53 /**
54 * Map containing default tags : "last_name", "last-name", "name" for {@link LuteceUser#NAME_FAMILY},
55 * "first-name", "first_name" for {@link LuteceUser#NAME_GIVEN}, "email" form {@link LuteceUser#HOME_INFO_ONLINE_EMAIL}
56 */
57 private static final Map<String, String[]> DEFAULT_TAGS = new HashMap<String, String[]>( );
58
59 static
60 {
61 DEFAULT_TAGS.put( LuteceUser.NAME_FAMILY, new String[] { "last-name", "last_name", "name", } );
62 DEFAULT_TAGS.put( LuteceUser.NAME_GIVEN, new String[] { "first-name", "first_name", } );
63 DEFAULT_TAGS.put( LuteceUser.HOME_INFO_ONLINE_EMAIL, new String[] { "email", } );
64 DEFAULT_TAGS.put( LuteceUser.HOME_INFO_ONLINE_URI, new String[] { "site", } );
65 }
66
67 private String _strFormat;
68
69 /**
70 * Tags we are looking for. Defaulted to {@link #DEFAULT_TAGS}
71 */
72 private Map<String, String[]> _tags = DEFAULT_TAGS;
73
74 /**
75 * Sets the supported format
76 * @param strFormat the supported format
77 */
78 public void setFormat( String strFormat )
79 {
80 _strFormat = strFormat;
81 }
82
83 /**
84 *
85 *{@inheritDoc}
86 */
87 public String getFormat( )
88 {
89 return _strFormat;
90 }
91
92 /**
93 * "Getter method" for {@link #_tags}.
94 * <br>Keys of the map is {@link LuteceUser} properties, values are tag that should be looked for.
95 * @return value of {@link #_tags}
96 */
97 public Map<String, String[]> getTags( )
98 {
99 return _tags;
100 }
101
102 /**
103 * "Setter method" for {@link #_tags}.
104 * <br>Keys of the map is {@link LuteceUser} properties, values are tag that should be looked for.
105 * @param tags new value of {@link #_tags}
106 */
107 public void setTags( Map<String, String[]> tags )
108 {
109 this._tags = tags;
110 }
111 }