fr.paris.lutece.plugins.identitystore.web.rs

Class IdentityStoreRestService

java.lang.Object

fr.paris.lutece.plugins.identitystore.web.rs.IdentityStoreRestService

public final class IdentityStoreRestService
extends Object

REST service for channel resource

Constructor Summary

Constructors

Constructor and Description
IdentityStoreRestService() private constructor

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	certifyIdentityAttributes(String strHeaderApplicationCode, com.sun.jersey.multipart.FormDataMultiPart formParams) certify identity attributes
javax.ws.rs.core.Response	createIdentity(String strHeaderApplicationCode, com.sun.jersey.multipart.FormDataMultiPart formParams) Creates an identity only if the identity does not already exist. The identity is created from the provided attributes. The order to test if the identity exists: by using the provided customer id if present by using the provided connection id if present
javax.ws.rs.core.Response	deleteIdentity(String strConnectionId, String strHeaderClientAppCode, String strQueryClientAppCode) Deletes an identity from the specified connectionId
javax.ws.rs.core.Response	downloadFileAttribute(String strConnectionId, String strHeaderClientAppCode, String strQueryClientAppCode, String strAttributeKey) returns requested file matching attributeKey / connectionId if application is authorized
javax.ws.rs.core.Response	getApplicationRights(String strClientAppCode) Gives list of application rights according to its application code, it miss must be consistent otherwise an AppException is thrown
javax.ws.rs.core.Response	getIdentity(String strConnectionId, String strCustomerId, String strHeaderClientAppCode, String strQueryClientAppCode) Gives Identity from a connectionId or customerID either connectionId or customerId must be provided if connectionId AND customerId are provided, they must be consistent otherwise an AppException is thrown
javax.ws.rs.core.Response	updateIdentity(String strHeaderApplicationCode, com.sun.jersey.multipart.FormDataMultiPart formParams) update identity method

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdentityStoreRestService

public IdentityStoreRestService()

private constructor

Method Detail

getIdentity

public javax.ws.rs.core.Response getIdentity(String strConnectionId,
                                             String strCustomerId,
                                             @HeaderParam(value="client_code")
                                             String strHeaderClientAppCode,
                                             String strQueryClientAppCode)

Gives Identity from a connectionId or customerID either connectionId or customerId must be provided if connectionId AND customerId are provided, they must be consistent otherwise an AppException is thrown

Parameters:

strConnectionId - connection ID

strCustomerId - customerID

strHeaderClientAppCode - client code

strQueryClientAppCode - client code, will be removed, use Header parameter instead

Returns:

the identity

updateIdentity

public javax.ws.rs.core.Response updateIdentity(@HeaderParam(value="client_code")
                                                String strHeaderApplicationCode,
                                                com.sun.jersey.multipart.FormDataMultiPart formParams)

update identity method

Parameters:

strHeaderApplicationCode - The client app code in header

formParams - form params, bodypars used for files upload

Returns:

http 200 if update is ok with ResponseDto

certifyIdentityAttributes

public javax.ws.rs.core.Response certifyIdentityAttributes(@HeaderParam(value="client_code")
                                                           String strHeaderApplicationCode,
                                                           com.sun.jersey.multipart.FormDataMultiPart formParams)

certify identity attributes

Parameters:

strHeaderApplicationCode -

formParams -

Returns:

200 ok : 204 no content

createIdentity

public javax.ws.rs.core.Response createIdentity(@HeaderParam(value="client_code")
                                                String strHeaderApplicationCode,
                                                com.sun.jersey.multipart.FormDataMultiPart formParams)

Creates an identity only if the identity does not already exist.
The identity is created from the provided attributes.

The order to test if the identity exists:

• by using the provided customer id if present
• by using the provided connection id if present

Parameters:

strHeaderApplicationCode -

formParams - form params, bodypars used for files upload

Returns:

http 200 if update is ok with ResponseDto

deleteIdentity

public javax.ws.rs.core.Response deleteIdentity(String strConnectionId,
                                                @HeaderParam(value="client_code")
                                                String strHeaderClientAppCode,
                                                String strQueryClientAppCode)

Deletes an identity from the specified connectionId

Parameters:

strConnectionId - the connection ID

strHeaderClientAppCode - the client code

strQueryClientAppCode - the client code in query

Returns:

a OK message if the deletion has been performed, a KO message otherwise

downloadFileAttribute

public javax.ws.rs.core.Response downloadFileAttribute(String strConnectionId,
                                                       @HeaderParam(value="client_code")
                                                       String strHeaderClientAppCode,
                                                       String strQueryClientAppCode,
                                                       String strAttributeKey)

returns requested file matching attributeKey / connectionId if application is authorized

Parameters:

strConnectionId - connectionId (must not be empty)

strHeaderClientAppCode - client application code (must not be empty)

strQueryClientAppCode - client application code in query

strAttributeKey - attribute key containing file (must not be empty)

Returns:

http 200 Response containing requested file, http 400 otherwise

getApplicationRights

public javax.ws.rs.core.Response getApplicationRights(@HeaderParam(value="client_code")
                                                      String strClientAppCode)

Gives list of application rights according to its application code, it miss must be consistent otherwise an AppException is thrown

Parameters:

strClientAppCode - client code from header

Returns:

the applications rights