com.covisint.platform.user.client.sdk

Class PersonSDK

java.lang.Object

com.covisint.core.http.service.client.BaseResourceClientFactory<PersonClientBuilder,PersonClientImpl>

com.covisint.platform.user.client.person.PersonClientFactory

com.covisint.platform.user.client.sdk.PersonSDK

public class PersonSDK
extends PersonClientFactory

Person SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PersonSDK.PersonClient Client interface for the Person resource APIs.

Constructor Summary

Constructors

Constructor and Description
PersonSDK(String serviceUrl) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
PersonClientImpl	create()
protected com.covisint.platform.oauth.client.token.sdk.AuthConfigurationProvider	getAuthConfigProvider() Method responsible for returning a AuthConfigurationProvider.
PersonSDK.PersonClient	newClient() Creates a new person client.
protected com.covisint.core.support.httpclient.HttpClientBuilder	populateHttpClientBuilder(com.covisint.core.support.httpclient.HttpClientBuilder builder)
PersonSDK	setAuthConfigProvider(com.covisint.platform.oauth.client.token.sdk.AuthConfigurationProvider provider) Sets the auth configuration provider for this SDK to use.

Methods inherited from class com.covisint.platform.user.client.person.PersonClientFactory

buildResourceClient, newBuilder

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

buildHttpClient, getCacheSpec, getConnectionCloseAfterResponseEnabled, getConnectionTimeout, getContentCharSet, getContentCompressionEnabled, getCookiesEnabled, getFollowRedirects, getHttpProxySpec, getMaxConcurrentRequests, getMaxRedirects, getServiceBaseUrl, getSocketBufferSize, getSocketTimeout, getSourceAddress, populateBaseBuilder, setCacheSpec, setConnectionCloseAfterResponseEnabled, setConnectionOptions, setConnectionTimeout, setContentCharSet, setContentCompressionEnabled, setCookiesEnabled, setFollowRedirects, setHttpProxySpec, setMaxConcurrentRequests, setMaxRedirects, setSocketBufferSize, setSocketOptions, setSocketTimeout, setSourceAddress

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonSDK

public PersonSDK(@Nonnull@NotEmpty
         String serviceUrl)

Constructor.

Parameters:

serviceUrl - the service url.

Method Detail

getAuthConfigProvider

@Nonnull
protected com.covisint.platform.oauth.client.token.sdk.AuthConfigurationProvider getAuthConfigProvider()

Method responsible for returning a AuthConfigurationProvider. The default implementation lazy-loads and returns a property file-based provider, which searches the classpath for the expected configuration file. This method may be overridden to allow custom providers.

Returns:

Returns a AuthConfigurationProvider.

populateHttpClientBuilder

protected com.covisint.core.support.httpclient.HttpClientBuilder populateHttpClientBuilder(@Nonnull
                                                                               com.covisint.core.support.httpclient.HttpClientBuilder builder)

Overrides:

populateHttpClientBuilder in class com.covisint.core.http.service.client.BaseResourceClientFactory<PersonClientBuilder,PersonClientImpl>

setAuthConfigProvider

public PersonSDK setAuthConfigProvider(@Nonnull
                              com.covisint.platform.oauth.client.token.sdk.AuthConfigurationProvider provider)

Sets the auth configuration provider for this SDK to use.

Parameters:

provider - The AuthConfigurationProvider to set.

Returns:

Returns this object.

create

public PersonClientImpl create()

Overrides:

create in class com.covisint.core.http.service.client.BaseResourceClientFactory<PersonClientBuilder,PersonClientImpl>

newClient

@Nonnull
public PersonSDK.PersonClient newClient()

Creates a new person client.

Returns:

returns a new person client.