com.covisint.platform.oauth.client.granttype.certificate

Interface CertificateGrantTypeClient

All Superinterfaces:

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

All Known Implementing Classes:

CertificateGrantTypeClientImpl

public interface CertificateGrantTypeClient
extends com.covisint.core.http.service.client.ResourceClient<CertificateGrantType>

Client for reading and updating information about CertificateGrantType.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<CertificateGrantType,com.covisint.core.http.service.core.ServiceException>	add(String subjectId, CertificateGrantType certificateGrantType, org.apache.http.protocol.HttpContext httpContext) create the certificate grant for a subject.
com.google.common.util.concurrent.CheckedFuture<CertificateGrantType,com.covisint.core.http.service.core.ServiceException>	delete(String subjectId, String grantTypeId, org.apache.http.protocol.HttpContext httpContext) Deletes the certificate grant for a subject.
com.google.common.util.concurrent.CheckedFuture<CertificateGrantType,com.covisint.core.http.service.core.ServiceException>	get(String subjectId, String grantTypeId, org.apache.http.protocol.HttpContext httpContext) Retrieves certificate grant for a subject.
com.google.common.util.concurrent.CheckedFuture<List<CertificateGrantType>,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<CertificateGrantType,com.covisint.core.http.service.core.ServiceException> get(@Nonnull@NotEmpty
                                                                                                                                     String subjectId,
                                                                                                                                     @Nonnull@NotEmpty
                                                                                                                                     String grantTypeId,
                                                                                                                                     @Nonnull
                                                                                                                                     org.apache.http.protocol.HttpContext httpContext)

Retrieves certificate grant for a subject.

Parameters:

subjectId - The subject id.

grantTypeId - The grant type id.

httpContext - The http context.

Returns:

The certificate grant type.

search

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<CertificateGrantType>,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<CertificateGrantType,com.covisint.core.http.service.core.ServiceException> add(@Nonnull@NotEmpty
                                                                                                                                     String subjectId,
                                                                                                                                     @Nonnull
                                                                                                                                     CertificateGrantType certificateGrantType,
                                                                                                                                     @Nonnull
                                                                                                                                     org.apache.http.protocol.HttpContext httpContext)

create the certificate grant for a subject.

Parameters:

subjectId - The subject id.

certificateGrantType - The certificate grant type resource.

httpContext - The http context.

Returns:

The certificate grant.

delete

@Nonnull
com.google.common.util.concurrent.CheckedFuture<CertificateGrantType,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 certificate grant for a subject.

Parameters:

subjectId - The subject id.

grantTypeId - The grant type id.

httpContext - The http context.

Returns:

The certificate grant.