Skip to content

Latest commit

 

History

History
155 lines (97 loc) · 7.29 KB

README.fr.md

File metadata and controls

155 lines (97 loc) · 7.29 KB
Raw

Alerte Line of code Coverage

Library Identityquality

Introduction

Cette librairie fournit des services pour communiquer avec l'API REST d'Identity Store Quality.

Pour plus d'information, la documentation de la librairie est disponible sur le wiki officiel.

Services

Le service principal est fr.paris.lutece.plugins.identityquality.v3.web.service.IdentityQualityService , qui fournit les méthodes permettant d'appeler Identity Store Quality.

Ces méthodes sont implémentées par le service de transport REST fr.paris.lutece.plugins.identityquality.v3.web.rs.service.IdentityQualityTransportRest .

Il requiert une implémentation de fr.paris.lutece.plugins.identityquality.v3.web.service.IHttpTransportProvider pour définir le transport HTTP. Deux implémentations de cette interface sont présentes dans cette librairie :

  • fr.paris.lutece.plugins.identityquality.v3.web.rs.service.HttpAccessTransport , qui utilise des requêtes simples
  • fr.paris.lutece.plugins.identityquality.v3.web.rs.service.HttpApiManagerAccessTransport , qui utilise l'ApiManager pour sécuriser les requêtesà l'API (en utilisant des tokens)

Ces deux implémentations ont besoin de la définition de l'URL vers le service d'Identity Store.

  • apiEndPointUrl , l'URL de l'endpoint de l'Identity store.

Pour utiliser HttpApiManagerAccessTransport , deux paramètres supplémentaires sont requis:

  • accessManagerEndPointUrl , l'URL de l'endpoint de l'API manager pour récupérer le token.
  • accessManagerCredentials , les credentials permettant d'accéder à l'API manager pour récupérer le token.

Configuration en utilisant le contexte Spring

Premièrement, définir le bean pour le transport HTTPà utiliser :

  • renseigner la propriété pour l'URL pointant vers le service d'Identity Store
  • renseigner les autres propriétés si le transport HTTP HttpApiManagerAccessTransport est utilisé

Ensuite, définir le bean pour le transport REST IdentityTransportRest :

  • comme argument de constructeur, faire référence au bean pour le transport HTTP

Ensuite, définir le bean pour le service IdentityService :

  • comme argument de constructeur, faire référence au bean pour le transport REST

Voici un exemple de configuration Spring avec le transport HTTP HttpAccessTransport :

<!-- library identitystore -->
<!-- IHttpTransportProvider declarations -->
<bean id="identitystore.httpAccessTransport" class="fr.paris.lutece.plugins.identityquality.v3.web.rs.service.HttpAccessTransport" >
<property name="apiEndPointUrl">
<value>${myplugin.identitystore.apiEndPointUrl}</value>
</property>
</bean>

<bean id="identity.restTransport.httpAccess" class="fr.paris.lutece.plugins.identityquality.v3.web.rs.service.IdentityQualityTransportRest">
<constructor-arg ref="identitystore.httpAccessTransport"/>
</bean>

<!-- IdentityService impl -->
<bean id="identity.identityService" class="fr.paris.lutece.plugins.identityquality.v3.web.service.IdentityQualityService">
<constructor-arg ref="identity.restTransport.httpAccess"/>
</bean>

Voici un exemple de configuration Spring avec le transport HTTP HttpApiManagerAccessTransport :

<!-- library identitystore -->
<!-- IHttpTransportProvider declarations -->
<bean id="identitystore.httpAccessTransport" class="fr.paris.lutece.plugins.identityquality.v3.web.rs.service.HttpApiManagerAccessTransport">
<property name="apiEndPointUrl">
<value>${myplugin.identitystore.ApiEndPointUrl}</value>
</property>
<property name="accessManagerEndPointUrl">
<value>${myplugin.identitystore.accessManagerEndPointUrl}</value>
</property>
<property name="accessManagerCredentials">
<value>${myplugin.identitystore.accessManagerCredentials}</value>
</property>
</bean>

<bean id="identity.restTransport.httpAccess" class="fr.paris.lutece.plugins.identityquality.v3.web.rs.service.IdentityQualityTransportRest">
<constructor-arg ref="identitystore.httpAccessTransport"/>
</bean>

<!-- IdentityService impl -->
<bean id="identity.identityService" class="fr.paris.lutece.plugins.identityquality.v3.web.service.IdentityQualityService">
<constructor-arg ref="identity.restTransport.httpAccess"/>
</bean>

Vous pouvez maintenant accéder au bean comme suit:

import fr.paris.lutece.plugins.identityquality.v3.web.service.IdentityQualityService;
...
private final IdentityQualityService _serviceQuality = SpringContextService.getBean( "identity.identityService" );

Configuration in Java code

Le service peutêtre directement créé dans le code Java. Voici un exemple avec le transport HTTP HttpApiManagerAccessTransport (le même mécanisme peutêtre appliqué pour le transport HTTP HttpAccessTransport ).

Premièrement, définir les clés suivantes dans un fichier de propriétés :

myplugin.identitystore.ApiEndPointUrl=http://mydomain.com/url/to/apimanager/api/identitystore
myplugin.identitystore.accessManagerEndPointUrl=http://mydomain.com/url/to/apimanager/token
myplugin.identitystore.accessManagerCredentials=your_private_key

Then, add the following code in the Java code:

...
private static final String PROPERTY_GRU_ENDPOINT_IDENTITYQUALITY = "myplugin.identitystore.ApiEndPointUrl";
private static final String PROPERTY_GRU_ENDPOINT_TOKEN = "myplugin.identitystore.accessManagerEndPointUrl";
private static final String PROPERTY_GRU_APIMANAGER_CREDENTIALS = "myplugin.identitystore.accessManagerCredentials";
...
final IdentityTransportApiManagerRest apiManagerTransport = new IdentityTransportApiManagerRest(  );
apiManagerTransport.setIdentityStoreEndPoint( AppPropertiesService.getProperty( PROPERTY_GRU_ENDPOINT_IDENTITYQUALITY ) );
apiManagerTransport.setApiManagerEndPoint( AppPropertiesService.getProperty( PROPERTY_GRU_ENDPOINT_TOKEN ) );
apiManagerTransport.setApiManagerCredentials( AppPropertiesService.getProperty( PROPERTY_GRU_APIMANAGER_CREDENTIALS ) );

final IdentityQualityService identityService = new IdentityQualityService( apiManagerTransport );
...

Maven documentation and reports

generated by xdoc2md - do not edit directly.