com.covisint.platform.oauth.client.granttype.clientsecret

Interface ClientSecretGrantTypeClient

All Superinterfaces:

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

All Known Implementing Classes:

ClientSecretGrantTypeClientImpl

public interface ClientSecretGrantTypeClient
extends com.covisint.core.http.service.client.ResourceClient<ClientSecretGrantType>

Client for reading and updating information about clientSecretGrantType.

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 clientSecretGrantType, org.apache.http.protocol.HttpContext httpContext) create the client secret grant for a subject.
com.google.common.util.concurrent.CheckedFuture<ClientSecretGrantType,com.covisint.core.http.service.core.ServiceException>	delete(String subjectId, String grantTypeId, org.apache.http.protocol.HttpContext httpContext) Deletes 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 grantTypeId, org.apache.http.protocol.HttpContext httpContext) Retrieves client secret grant for a subject.
com.google.common.util.concurrent.CheckedFuture<List<ClientSecretGrantType>,com.covisint.core.http.service.core.ServiceException>	search(String subjectId, com.google.common.collect.Multimap<String,String> searchCriteria, com.covisint.core.http.service.core.SortCriteria sortCriteria, com.covisint.core.http.service.core.Page page, org.apache.http.protocol.HttpContext httpContext) Search for grant types based on the passed search criteria for a subject.

Methods inherited from interface com.covisint.core.http.service.client.ResourceClient

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

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 grantTypeId,
                                                                                                                                      @Nonnull
                                                                                                                                      org.apache.http.protocol.HttpContext httpContext)

Retrieves client secret grant for a subject.

Parameters:

subjectId - The subject id.

grantTypeId - The grant type id.

httpContext - The http context.

Returns:

The client secret grant type.

search

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<ClientSecretGrantType>,com.covisint.core.http.service.core.ServiceException> search(@Nonnull@NotEmpty
                                                                                                                                               String subjectId,
                                                                                                                                               @Nonnull
                                                                                                                                               com.google.common.collect.Multimap<String,String> searchCriteria,
                                                                                                                                               @Nonnull
                                                                                                                                               com.covisint.core.http.service.core.SortCriteria sortCriteria,
                                                                                                                                               @Nonnull
                                                                                                                                               com.covisint.core.http.service.core.Page page,
                                                                                                                                               @Nonnull
                                                                                                                                               org.apache.http.protocol.HttpContext httpContext)

Search for grant types based on the passed search criteria for a subject.

Parameters:

subjectId - The subject id.

searchCriteria - search information about the query

sortCriteria - sort information about the query

page - the page of data to retrieve

httpContext - the HTTP Context containing session-level data

Returns:

all matching resources found in the system

add

@Nonnull
com.google.common.util.concurrent.CheckedFuture<ClientSecretGrantType,com.covisint.core.http.service.core.ServiceException> add(@Nonnull@NotEmpty
                                                                                                                                      String subjectId,
                                                                                                                                      @Nonnull
                                                                                                                                      ClientSecretGrantType clientSecretGrantType,
                                                                                                                                      @Nonnull
                                                                                                                                      org.apache.http.protocol.HttpContext httpContext)

create the client secret grant for a subject.

Parameters:

subjectId - The subject id.

clientSecretGrantType - The client secret grant type resource.

httpContext - The http context.

Returns:

The client secret grant.

delete

@Nonnull
com.google.common.util.concurrent.CheckedFuture<ClientSecretGrantType,com.covisint.core.http.service.core.ServiceException> delete(@Nonnull@NotEmpty
                                                                                                                                         String subjectId,
                                                                                                                                         @Nonnull@NotEmpty
                                                                                                                                         String grantTypeId,
                                                                                                                                         @Nonnull
                                                                                                                                         org.apache.http.protocol.HttpContext httpContext)

Deletes the client secret grant for a subject.

Parameters:

subjectId - The subject id.

grantTypeId - The grant type id.

httpContext - The http context.

Returns:

The client secret grant.