com.covisint.platform.authn.client.password

Class PasswordClientImpl

java.lang.Object

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

com.covisint.platform.authn.client.password.PasswordClientImpl

All Implemented Interfaces:

com.covisint.core.http.service.client.ResourceClient<Password>, PasswordClient

public final class PasswordClientImpl
extends com.covisint.core.http.service.client.BaseResourceClient<Password>
implements PasswordClient

A basic client for CRUD operations on Password resources.

Field Summary

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

ID_URL_VAR

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<Password,com.covisint.core.http.service.core.ServiceException>	add(Password resource, org.apache.http.protocol.HttpContext httpContext)
com.google.common.util.concurrent.CheckedFuture<PasswordAuthenticationResponse,com.covisint.core.http.service.core.ServiceException>	authentication(PasswordAuthenticationRequest request, org.apache.http.protocol.HttpContext httpContext) Authenticates a subject by their password.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	batchUpdateAuthnPolicyIds(PasswordBatchUpdateRequest request, org.apache.http.protocol.HttpContext httpContext) Will batch update authentication policy ids for the subjects.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	batchUpdatePasswordPolicyIds(PasswordBatchUpdateRequest request, org.apache.http.protocol.HttpContext httpContext) Will batch update password policy ids for the subjects.
com.google.common.util.concurrent.CheckedFuture<Password,com.covisint.core.http.service.core.ServiceException>	delete(String id, org.apache.http.protocol.HttpContext httpContext)
com.google.common.util.concurrent.CheckedFuture<Password,com.covisint.core.http.service.core.ServiceException>	expirePassword(String subject, org.apache.http.protocol.HttpContext httpContext) Expires password of given subject.
com.google.common.util.concurrent.CheckedFuture<Password,com.covisint.core.http.service.core.ServiceException>	getPassword(String userId, org.apache.http.protocol.HttpContext httpContext) Retrieve a password via the owning user id.
com.google.common.util.concurrent.CheckedFuture<Password,com.covisint.core.http.service.core.ServiceException>	lockPassword(String subject, org.apache.http.protocol.HttpContext httpContext) Locks password of given subject for a specified period of time.
com.google.common.util.concurrent.CheckedFuture<Password,com.covisint.core.http.service.core.ServiceException>	lockPassword(String subject, long lockDuration, TimeUnit durationUnit, org.apache.http.protocol.HttpContext httpContext) Locks password of given subject for a specified period of time.
com.google.common.util.concurrent.CheckedFuture<Password,com.covisint.core.http.service.core.ServiceException>	persist(Password resource, org.apache.http.protocol.HttpContext httpContext)
com.google.common.util.concurrent.CheckedFuture<Password,com.covisint.core.http.service.core.ServiceException>	unlockPassword(String subject, org.apache.http.protocol.HttpContext httpContext) Unlocks password of given subject.
com.google.common.util.concurrent.CheckedFuture<Password,com.covisint.core.http.service.core.ServiceException>	updatePassword(Password newPassword, UpdateMode updateMode, org.apache.http.protocol.HttpContext httpContext) Specify a new password for the user.

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

buildSearchKey, doGet, execute, executeWithBody, executeWithBody, executeWithPrecondition, get, get, getEndpointWithQueryParams, getLocalCache, search, 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

get, get, search, search

Method Detail

getPassword

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

Retrieve a password via the owning user id.

Specified by:

getPassword in interface PasswordClient

Parameters:

userId - The id of the user owning this password

httpContext - The HTTP context

Returns:

Returns a checked future, resulting in a password if it exists, or throws an HttpServiceException on any errors

updatePassword

public com.google.common.util.concurrent.CheckedFuture<Password,com.covisint.core.http.service.core.ServiceException> updatePassword(@Nonnull
                                                                                                                            Password newPassword,
                                                                                                                            @Nonnull
                                                                                                                            UpdateMode updateMode,
                                                                                                                            @Nonnull
                                                                                                                            org.apache.http.protocol.HttpContext httpContext)

Specify a new password for the user. This will create a password if it doesn't already exist, updating it otherwise. The password must be valid, according to the specified policy.

Specified by:

updatePassword in interface PasswordClient

Parameters:

newPassword - The new password to apply

updateMode - The context under which this password is being updated

httpContext - The HTTP context for this call

Returns:

The password future, allowing checked exception HttpServiceException. If successful, the future will produce the new password entry in effect.

expirePassword

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

Expires password of given subject.

Specified by:

expirePassword in interface PasswordClient

Parameters:

subject - subject id of the password resource

httpContext - The HTTP context

Returns:

Returns a checked future, resulting in a updated password if it exists, or throws an HttpServiceException on any errors

lockPassword

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

Locks password of given subject for a specified period of time.

Specified by:

lockPassword in interface PasswordClient

Parameters:

subject - subject id of the password resource

httpContext - The HTTP context

Returns:

Returns a checked future, resulting in a updated password if it exists, or throws an ServiceException on any errors.

lockPassword

public com.google.common.util.concurrent.CheckedFuture<Password,com.covisint.core.http.service.core.ServiceException> lockPassword(@Nonnull@NotEmpty
                                                                                                                          String subject,
                                                                                                                          long lockDuration,
                                                                                                                          @Nonnull
                                                                                                                          TimeUnit durationUnit,
                                                                                                                          @Nonnull
                                                                                                                          org.apache.http.protocol.HttpContext httpContext)

Locks password of given subject for a specified period of time.

Specified by:

lockPassword in interface PasswordClient

Parameters:

subject - subject id of the password resource

lockDuration - length of time the account will remain locked

durationUnit - unit of time the lockout duration is expressed in

httpContext - The HTTP context

Returns:

Returns a checked future, resulting in a updated password if it exists, or throws an ServiceException on any errors.

unlockPassword

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

Unlocks password of given subject.

Specified by:

unlockPassword in interface PasswordClient

Parameters:

subject - subject id of the password resource

httpContext - The HTTP context

Returns:

Returns a checked future, resulting in a updated password if it exists, or throws an ServiceException on any errors

authentication

public com.google.common.util.concurrent.CheckedFuture<PasswordAuthenticationResponse,com.covisint.core.http.service.core.ServiceException> authentication(@Nonnull
                                                                                                                                                  PasswordAuthenticationRequest request,
                                                                                                                                                  @Nonnull
                                                                                                                                                  org.apache.http.protocol.HttpContext httpContext)

Authenticates a subject by their password.

Specified by:

authentication in interface PasswordClient

Parameters:

request - the request

httpContext - The HTTP context

Returns:

the response

batchUpdateAuthnPolicyIds

public com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException> batchUpdateAuthnPolicyIds(@Nonnull
                                                                                                                                   PasswordBatchUpdateRequest request,
                                                                                                                                   @Nonnull
                                                                                                                                   org.apache.http.protocol.HttpContext httpContext)

Will batch update authentication policy ids for the subjects.

Specified by:

batchUpdateAuthnPolicyIds in interface PasswordClient

Parameters:

request - PasswordBatchUpdateRequest

httpContext - The HTTP context

Returns:

no response will throw exception in case of error.

batchUpdatePasswordPolicyIds

public com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException> batchUpdatePasswordPolicyIds(@Nonnull
                                                                                                                                      PasswordBatchUpdateRequest request,
                                                                                                                                      @Nonnull
                                                                                                                                      org.apache.http.protocol.HttpContext httpContext)

Will batch update password policy ids for the subjects.

Specified by:

batchUpdatePasswordPolicyIds in interface PasswordClient

Parameters:

request - PasswordBatchUpdateRequest

httpContext - The HTTP context

Returns:

no response will throw exception in case of error.

add

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

Specified by:

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

Overrides:

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

persist

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

Specified by:

persist in interface com.covisint.core.http.service.client.ResourceClient<Password>

Overrides:

persist in class com.covisint.core.http.service.client.BaseResourceClient<Password>

delete

public com.google.common.util.concurrent.CheckedFuture<Password,com.covisint.core.http.service.core.ServiceException> delete(String id,
                                                                                                                    org.apache.http.protocol.HttpContext httpContext)

Specified by:

delete in interface com.covisint.core.http.service.client.ResourceClient<Password>

Overrides:

delete in class com.covisint.core.http.service.client.BaseResourceClient<Password>