com.covisint.platform.authn.client.userpin

Interface PinClient

All Superinterfaces:

com.covisint.core.http.service.client.ResourceClient<Pin>

All Known Implementing Classes:

PinClientImpl

public interface PinClient
extends com.covisint.core.http.service.client.ResourceClient<Pin>

Client that is used for PIN CRUD operations.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<Boolean,com.covisint.core.http.service.core.ServiceException>	isExisting(String subject, org.apache.http.protocol.HttpContext httpContext) Validate if the pin existing for the user.
com.google.common.util.concurrent.CheckedFuture<Boolean,com.covisint.core.http.service.core.ServiceException>	validatePIN(String id, String pin, String requestor, org.apache.http.protocol.HttpContext httpContext) Validate the pin.

Methods inherited from interface com.covisint.core.http.service.client.ResourceClient

add, delete, get, get, persist, search, search

Method Detail

validatePIN

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Boolean,com.covisint.core.http.service.core.ServiceException> validatePIN(@Nonnull@NotEmpty
                                                                                                                                String id,
                                                                                                                                @Nonnull@NotEmpty
                                                                                                                                String pin,
                                                                                                                                @Nonnull@NotEmpty
                                                                                                                                String requestor,
                                                                                                                                @Nonnull
                                                                                                                                org.apache.http.protocol.HttpContext httpContext)

Validate the pin. This method will use subject and realm to determine the pin record.

Parameters:

id - the subject name of user.

pin - the pin number.

requestor - the requestor.

httpContext - http context which should include prefer language.

Returns:

ServiceException with 204 code if the validation result is correct. HttpServiceException with 401 code if the validation result is correct.

isExisting

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Boolean,com.covisint.core.http.service.core.ServiceException> isExisting(@Nonnull@NotEmpty
                                                                                                                               String subject,
                                                                                                                               @Nonnull
                                                                                                                               org.apache.http.protocol.HttpContext httpContext)

Validate if the pin existing for the user.

Parameters:

subject - the subject name of user.

httpContext - http context which should include prefer language.

Returns:

HttpServiceException with 204 code if the validation result is correct. HttpServiceException with 404 code if the pin is not existing for this user