View Javadoc
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  import fr.paris.lutece.portal.service.util.AppLogService;
38  
39  import org.apache.http.HttpResponse;
40  
41  import org.w3c.dom.Document;
42  import org.w3c.dom.NodeList;
43  
44  import org.xml.sax.SAXException;
45  
46  import java.io.IOException;
47  
48  import java.util.Map.Entry;
49  
50  import javax.xml.parsers.DocumentBuilder;
51  import javax.xml.parsers.DocumentBuilderFactory;
52  import javax.xml.parsers.ParserConfigurationException;
53  
54  
55  /**
56   *
57   * XMLCredentialRetriever : parses credential XML.
58   * <br>
59   * Set the tags map to enhance info parsing.
60   * Keys of the map is {@link LuteceUser} properties, values are tag that should be looked for.
61   * @see AbstractOAuthCredentialsRetriever#DEFAULT_TAGS
62   * @see LuteceUser#NAME_FAMILY
63   */
64  public class XMLCredentialRetriever extends AbstractOAuthCredentialsRetriever
65  {
66      /**
67       *
68       *{@inheritDoc}
69       */
70      public void doRetrieveUserInfo( HttpResponse httpResponse, OAuthUser user )
71      {
72          try
73          {
74              DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(  );
75              DocumentBuilder builder = factory.newDocumentBuilder(  );
76              Document doc = builder.parse( httpResponse.getEntity(  ).getContent(  ) );
77  
78              for ( Entry<String, String[]> entry : getTags(  ).entrySet(  ) )
79              {
80                  for ( String strTag : entry.getValue(  ) )
81                  {
82                      NodeList nodeList = doc.getElementsByTagName( strTag );
83  
84                      if ( ( nodeList != null ) && ( nodeList.getLength(  ) > 0 ) )
85                      {
86                          String strValue = nodeList.item( 0 ).getFirstChild(  ).getNodeValue(  );
87  
88                          if ( AppLogService.isDebugEnabled(  ) )
89                          {
90                              AppLogService.debug( "Retrieved " + strValue + " for " + entry.getKey(  ) );
91                          }
92  
93                          user.setUserInfo( entry.getKey(  ), strValue );
94  
95                          if ( entry.getKey(  ).equals( LuteceUser.NAME_FAMILY ) )
96                          {
97                              user.setName( strValue );
98                          }
99  
100                         break; // no need to find other values
101                     }
102                 }
103             }
104         }
105         catch ( SAXException e )
106         {
107             AppLogService.error( e.getMessage(  ), e );
108         }
109         catch ( ParserConfigurationException e )
110         {
111             AppLogService.error( e.getMessage(  ), e );
112         }
113         catch ( IllegalStateException e )
114         {
115             AppLogService.error( e.getMessage(  ), e );
116         }
117         catch ( IOException e )
118         {
119             AppLogService.error( e.getMessage(  ), e );
120         }
121     }
122 }