com.covisint.platform.authn.client.password

Interface PasswordClient

All Superinterfaces:

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

All Known Implementing Classes:

PasswordClientImpl

public interface PasswordClient
extends com.covisint.core.http.service.client.ResourceClient<Password>

Client that is used for password CRUD operations and authentication functions.

Method Summary

Methods

Modifier and Type	Method and Description
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>	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>	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 interface com.covisint.core.http.service.client.ResourceClient

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

Method Detail

getPassword

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

Retrieve a password via the owning user id.

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

@Nonnull
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.

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

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

Expires password of given subject.

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

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

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

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

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

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

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

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

Unlocks password of given subject.

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

@Nonnull
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.

Parameters:

request - the request

httpContext - The HTTP context

Returns:

the response

batchUpdateAuthnPolicyIds

@Nonnull
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.

Parameters:

request - PasswordBatchUpdateRequest

httpContext - The HTTP context

Returns:

no response will throw exception in case of error.

batchUpdatePasswordPolicyIds

@Nonnull
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.

Parameters:

request - PasswordBatchUpdateRequest

httpContext - The HTTP context

Returns:

no response will throw exception in case of error.