com.covisint.platform.user.client.person

Class PersonClientImpl

java.lang.Object

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

com.covisint.platform.user.client.person.PersonClientImpl

All Implemented Interfaces:

com.covisint.core.http.service.client.ResourceClient<Person>, PersonClient

public class PersonClientImpl
extends com.covisint.core.http.service.client.BaseResourceClient<Person>
implements PersonClient

Basic implementation of a PersonClient.

Field Summary

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

ID_URL_VAR

Constructor Summary

Constructors

Constructor and Description
PersonClientImpl()

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	activate(String personId, org.apache.http.protocol.HttpContext context) Activates a Person in pending status.
com.google.common.util.concurrent.CheckedFuture<Person,com.covisint.core.http.service.core.ServiceException>	delete(String id, org.apache.http.protocol.HttpContext httpContext)
void	setActivateEndpointTemplate(com.damnhandy.uri.template.UriTemplate template) Sets the "activate person endpoint" URI template.
void	setSuspendEndpointTemplate(com.damnhandy.uri.template.UriTemplate template) Sets the "suspend person endpoint" URI template.
void	setUnsuspendEndpointTemplate(com.damnhandy.uri.template.UriTemplate template) Sets the "unsuspend person endpoint" URI template.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	suspend(String personId, org.apache.http.protocol.HttpContext context) Suspends a Person in active status.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	unsuspend(String personId, org.apache.http.protocol.HttpContext context) Unsuspends a Person in suspend status.

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

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

add, get, get, persist, search, search

Constructor Detail

PersonClientImpl

public PersonClientImpl()

Method Detail

activate

public final com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException> activate(@Nonnull@NotEmpty
                                                                                                                  String personId,
                                                                                                                  @Nonnull
                                                                                                                  org.apache.http.protocol.HttpContext context)

Activates a Person in pending status.

Specified by:

activate in interface PersonClient

Parameters:

personId - The id of the Person to activate.

context - The HTTP context used to pass state.

Returns:

Returns a future which can be used to check for successful completion (or error).

suspend

public final com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException> suspend(@Nonnull@NotEmpty
                                                                                                                 String personId,
                                                                                                                 @Nonnull
                                                                                                                 org.apache.http.protocol.HttpContext context)

Suspends a Person in active status.

Specified by:

suspend in interface PersonClient

Parameters:

personId - The id of the Person to suspend.

context - The HTTP context used to pass state.

Returns:

Returns a future which can be used to check for successful completion (or error).

unsuspend

public final com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException> unsuspend(@Nonnull@NotEmpty
                                                                                                                   String personId,
                                                                                                                   @Nonnull
                                                                                                                   org.apache.http.protocol.HttpContext context)

Unsuspends a Person in suspend status.

Specified by:

unsuspend in interface PersonClient

Parameters:

personId - The id of the Person to unsuspend.

context - The HTTP context used to pass state.

Returns:

Returns a future which can be used to check for successful completion (or error).

setActivateEndpointTemplate

public final void setActivateEndpointTemplate(@Nonnull
                               com.damnhandy.uri.template.UriTemplate template)

Sets the "activate person endpoint" URI template.

Parameters:

template - The URI template to set.

setSuspendEndpointTemplate

public final void setSuspendEndpointTemplate(@Nonnull
                              com.damnhandy.uri.template.UriTemplate template)

Sets the "suspend person endpoint" URI template.

Parameters:

template - The URI template to set.

setUnsuspendEndpointTemplate

public final void setUnsuspendEndpointTemplate(@Nonnull
                                com.damnhandy.uri.template.UriTemplate template)

Sets the "unsuspend person endpoint" URI template.

Parameters:

template - The URI template to set.

delete

public final com.google.common.util.concurrent.CheckedFuture<Person,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<Person>

Overrides:

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