com.emc.vipr.client.core

Class AuthnProviders

java.lang.Object

com.emc.vipr.client.core.AbstractResources<T>

com.emc.vipr.client.core.AbstractCoreResources<AuthnProviderRestRep>

com.emc.vipr.client.core.AuthnProviders

All Implemented Interfaces:

Resources<AuthnProviderRestRep>, TopLevelResources<AuthnProviderRestRep>

public class AuthnProviders
extends AbstractCoreResources<AuthnProviderRestRep>
implements TopLevelResources<AuthnProviderRestRep>

Authentication Providers resources.

Base URL: /vdc/admin/authnproviders

See Also:

AuthnProviderRestRep

Constructor Summary

Constructors

Constructor and Description
AuthnProviders(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
AuthnProviderRestRep	create(AuthnCreateParam input) Creates an authentication provider.
void	delete(java.net.URI id) Deletes an authentication provider.
AuthnProviderRestRep	forceUpdate(java.net.URI id, AuthnUpdateParam input) Updates an authentication provider with allow_group_attr_change set to true.
java.util.List<AuthnProviderRestRep>	getAll() Gets all resources for this resource type.
java.util.List<AuthnProviderRestRep>	getAll(ResourceFilter<AuthnProviderRestRep> filter) Gets all resources for this resource type.
java.util.List<NamedRelatedResourceRep>	list() Lists all authentication providers.
AuthnProviderRestRep	update(java.net.URI id, AuthnUpdateParam input) Updates an authentication provider.
AuthnProviders	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
AuthnProviders	withInternal(boolean internal) Configures the fetch operations to include internal resources.

Methods inherited from class com.emc.vipr.client.core.AbstractResources

addTags, get, get, getByIds, getByIds, getByRefs, getByRefs, getTags, performSearch, performSearchBy, removeTags, search, updateTags

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthnProviders

public AuthnProviders(ViPRCoreClient parent,
                      RestClient client)

Method Detail

withInactive

public AuthnProviders withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<AuthnProviderRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public AuthnProviders withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<AuthnProviderRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

list

public java.util.List<NamedRelatedResourceRep> list()

Lists all authentication providers.

API Call: GET /vdc/admin/authnproviders

Specified by:

list in interface TopLevelResources<AuthnProviderRestRep>

Returns:

the list of authentication providers.

getAll

public java.util.List<AuthnProviderRestRep> getAll()

Description copied from interface: TopLevelResources

Gets all resources for this resource type. This is combination of the list() call combined with a bulk query to retrieve the resources.

API Call: GET /RESOURCE_PATH

Specified by:

getAll in interface TopLevelResources<AuthnProviderRestRep>

Returns:

All resources of this type available to the user.

See Also:

TopLevelResources.list(), Resources.getByRefs(java.util.Collection)

getAll

public java.util.List<AuthnProviderRestRep> getAll(ResourceFilter<AuthnProviderRestRep> filter)

Description copied from interface: TopLevelResources

Gets all resources for this resource type. This is combination of the list() call combined with a bulk query to retrieve the resources. This optionally filters the results by the filter specified.

API Call: GET /RESOURCE_PATH

Specified by:

getAll in interface TopLevelResources<AuthnProviderRestRep>

Parameters:

filter - the resource filter to apply to the results as they are returned (optional).

Returns:

Filtered list of resources of this type available to the user.

See Also:

TopLevelResources.list(), Resources.getByRefs(java.util.Collection, ResourceFilter)

create

public AuthnProviderRestRep create(AuthnCreateParam input)

Creates an authentication provider.

API Call: POST /vdc/admin/authnproviders

Parameters:

input - the create configuration.

Returns:

the created authentication provider.

update

public AuthnProviderRestRep update(java.net.URI id,
                                   AuthnUpdateParam input)

Updates an authentication provider.

API Call: PUT /vdc/admin/authnproviders/{id}

Parameters:

id - the authentication provider ID.

input - the update configuration.

Returns:

the updated authentication provider.

forceUpdate

public AuthnProviderRestRep forceUpdate(java.net.URI id,
                                        AuthnUpdateParam input)

Updates an authentication provider with allow_group_attr_change set to true.

API Call: PUT /vdc/admin/authnproviders/{id}?allow_group_attr_change=true

Parameters:

id - the authentication provider ID.

input - the update configuration.

Returns:

the updated authentication provider.

delete

public void delete(java.net.URI id)

Deletes an authentication provider.

API Call: DELETE /vdc/admin/authnproviders/{id}

Parameters:

id - the authentication provider ID.