com.covisint.platform.authn.client.userpin

Class PinClientImpl

java.lang.Object

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

com.covisint.platform.authn.client.userpin.PinClientImpl

All Implemented Interfaces:

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

public class PinClientImpl
extends com.covisint.core.http.service.client.BaseResourceClient<Pin>
implements PinClient

A basic client for the PIN service. Multi-lingual Support: A List of language tags can be placed in the HttpContext object using the key languageTags. These language tags will be sent to the server via the Accept-Language header.

Field Summary

Fields inherited from class com.covisint.core.http.service.client.BaseResourceClient

ID_URL_VAR

Constructor Summary

Constructors

Constructor and Description
PinClientImpl() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<Pin,com.covisint.core.http.service.core.ServiceException>	add(Pin resource, org.apache.http.protocol.HttpContext httpContext)
com.damnhandy.uri.template.UriTemplate	getExistingEndpointTemplate() Gets the URI template for the existing endpoint.
com.damnhandy.uri.template.UriTemplate	getValidateEndpointTemplate() Gets the URI template for the validate endpoint.
com.google.common.util.concurrent.CheckedFuture<Boolean,com.covisint.core.http.service.core.ServiceException>	isExisting(String id, org.apache.http.protocol.HttpContext httpContext) Validate if the pin existing for the user.
com.google.common.util.concurrent.CheckedFuture<List<Pin>,com.covisint.core.http.service.core.ServiceException>	search(com.google.common.collect.Multimap<String,String> searchCriteria, com.covisint.core.http.service.core.SortCriteria sortCriteria, com.covisint.core.http.service.core.Page page, org.apache.http.protocol.HttpContext httpContext)
void	setExistingEndpointTemplate(com.damnhandy.uri.template.UriTemplate newExistingEndpointTemplate) Sets the URI template for the existing endpoint.
void	setValidateEndpointTemplate(com.damnhandy.uri.template.UriTemplate newValidateEndpointTemplate) Sets the URI template for the validate endpoint.
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 class com.covisint.core.http.service.client.BaseResourceClient

buildSearchKey, delete, doGet, execute, executeWithBody, executeWithBody, executeWithPrecondition, get, get, getEndpointWithQueryParams, getLocalCache, persist, search

Methods inherited from class java.lang.Object

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

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

delete, get, get, persist, search

Constructor Detail

PinClientImpl

public PinClientImpl()

Constructor.

Method Detail

validatePIN

public 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.

Specified by:

validatePIN in interface PinClient

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

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

Validate if the pin existing for the user.

Specified by:

isExisting in interface PinClient

Parameters:

id - 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

getValidateEndpointTemplate

public com.damnhandy.uri.template.UriTemplate getValidateEndpointTemplate()

Gets the URI template for the validate endpoint.

Returns:

the uri template

setValidateEndpointTemplate

public void setValidateEndpointTemplate(com.damnhandy.uri.template.UriTemplate newValidateEndpointTemplate)

Sets the URI template for the validate endpoint.

Parameters:

newValidateEndpointTemplate - The URI template to set.

getExistingEndpointTemplate

public com.damnhandy.uri.template.UriTemplate getExistingEndpointTemplate()

Gets the URI template for the existing endpoint.

Returns:

the uri template.

setExistingEndpointTemplate

public void setExistingEndpointTemplate(com.damnhandy.uri.template.UriTemplate newExistingEndpointTemplate)

Sets the URI template for the existing endpoint.

Parameters:

newExistingEndpointTemplate - The URI template to set.

search

public com.google.common.util.concurrent.CheckedFuture<List<Pin>,com.covisint.core.http.service.core.ServiceException> search(com.google.common.collect.Multimap<String,String> searchCriteria,
                                                                                                                     com.covisint.core.http.service.core.SortCriteria sortCriteria,
                                                                                                                     com.covisint.core.http.service.core.Page page,
                                                                                                                     org.apache.http.protocol.HttpContext httpContext)

Specified by:

search in interface com.covisint.core.http.service.client.ResourceClient<Pin>

Overrides:

search in class com.covisint.core.http.service.client.BaseResourceClient<Pin>

add

public com.google.common.util.concurrent.CheckedFuture<Pin,com.covisint.core.http.service.core.ServiceException> add(Pin resource,
                                                                                                            org.apache.http.protocol.HttpContext httpContext)

Specified by:

add in interface com.covisint.core.http.service.client.ResourceClient<Pin>

Overrides:

add in class com.covisint.core.http.service.client.BaseResourceClient<Pin>