com.covisint.platform.oauth.client.sdk

Interface ClientSecretGrantTypeSDK.ClientSecretGrantTypeClient

Enclosing class:

ClientSecretGrantTypeSDK

public static interface ClientSecretGrantTypeSDK.ClientSecretGrantTypeClient

Client interface for the ClientSecretGrantType resource APIs.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<ClientSecretGrantType,com.covisint.core.http.service.core.ServiceException>	add(String subjectId, ClientSecretGrantType grant) Add a client secret grant for a subject.
com.google.common.util.concurrent.CheckedFuture<ClientSecretGrantType,com.covisint.core.http.service.core.ServiceException>	delete(String subjectId, String grantId) Delete the client secret grant for a subject.
com.google.common.util.concurrent.CheckedFuture<ClientSecretGrantType,com.covisint.core.http.service.core.ServiceException>	get(String subjectId, String grantId) Retrieves the client secret grant for a subject.
com.google.common.util.concurrent.CheckedFuture<List<ClientSecretGrantType>,com.covisint.core.http.service.core.ServiceException>	listClientSecretGrants(String subjectId, com.covisint.core.http.service.core.Page page) List all client secret grants issued to a subject.

Method Detail

get

@Nonnull
com.google.common.util.concurrent.CheckedFuture<ClientSecretGrantType,com.covisint.core.http.service.core.ServiceException> get(@Nonnull@NotEmpty
                                                                                                                                      String subjectId,
                                                                                                                                      @Nonnull@NotEmpty
                                                                                                                                      String grantId)

Retrieves the client secret grant for a subject.

Parameters:

subjectId - The subject id.

grantId - The grant id.

Returns:

Returns a future providing the retrieved client secret grant, or null if one doesn't exist for the given subject and id.

listClientSecretGrants

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<ClientSecretGrantType>,com.covisint.core.http.service.core.ServiceException> listClientSecretGrants(@Nonnull@NotEmpty
                                                                                                                                                               String subjectId,
                                                                                                                                                               @Nonnull
                                                                                                                                                               com.covisint.core.http.service.core.Page page)

List all client secret grants issued to a subject.

Parameters:

subjectId - The subject id.

page - the page of data to retrieve

Returns:

Returns a future producing the client secret grants issued to the subject. May be an empty collection.

add

@Nonnull
com.google.common.util.concurrent.CheckedFuture<ClientSecretGrantType,com.covisint.core.http.service.core.ServiceException> add(@Nonnull@NotEmpty
                                                                                                                                      String subjectId,
                                                                                                                                      @Nonnull
                                                                                                                                      ClientSecretGrantType grant)

Add a client secret grant for a subject.

Parameters:

subjectId - The subject id for which the grant is being issued.

grant - The client secret grant to add.

Returns:

Returns a future producing the created client secret grant. This object contains the server-issued id and version.

delete

@Nonnull
com.google.common.util.concurrent.CheckedFuture<ClientSecretGrantType,com.covisint.core.http.service.core.ServiceException> delete(@Nonnull@NotEmpty
                                                                                                                                         String subjectId,
                                                                                                                                         @Nonnull@NotEmpty
                                                                                                                                         String grantId)

Delete the client secret grant for a subject.

Parameters:

subjectId - The subject id.

grantId - The id of the grant being deleted.

Returns:

Returns a future which, when completed, indicates that the given grant has been deleted from the subject.