Package org.openstack4j.api.client

Interface IOSClientBuilder.V3

All Superinterfaces:

IOSClientBuilder<OSClient.OSClientV3,IOSClientBuilder.V3>

All Known Implementing Classes:

OSClientBuilder.ClientV3

Enclosing interface:

IOSClientBuilder<R,T extends IOSClientBuilder<R,T>>

public static interface IOSClientBuilder.V3
extends IOSClientBuilder<OSClient.OSClientV3,IOSClientBuilder.V3>

OpenStack4j Client builder which authenticates against version V3

Nested Class Summary

Nested classes/interfaces inherited from interface org.openstack4j.api.client.IOSClientBuilder

IOSClientBuilder.V2, IOSClientBuilder.V3

Method Summary

Modifier and Type	Method	Description
IOSClientBuilder.V3	credentials(String userName, String password, Identifier domain)	The authentication credentials and default scoped domain
IOSClientBuilder.V3	domainId(String domainId)	Deprecated.
IOSClientBuilder.V3	domainName(String domainName)	Deprecated.
IOSClientBuilder.V3	scopeToDomain(Identifier domain)	Scopes the token to a domain level
IOSClientBuilder.V3	scopeToProject(Identifier project)	scopes the token to a project level
IOSClientBuilder.V3	scopeToProject(Identifier project, Identifier domain)	Scopes the token to a project level
IOSClientBuilder.V3	token(String tokenId)	A token object.

Methods inherited from interface org.openstack4j.api.client.IOSClientBuilder

authenticate, credentials, endpoint, perspective, provider, useNonStrictSSLClient, withConfig

Method Detail

credentials

IOSClientBuilder.V3 credentials(String userName,
                                String password,
                                Identifier domain)

The authentication credentials and default scoped domain

Parameters:

userName - the user name to authenticate with

password - the password to authenticate with

domain - the domain if using "default scoped"

Returns:

self for method chaining

domainName

@Deprecated
IOSClientBuilder.V3 domainName(String domainName)

Deprecated.

DEPRECATED: Please use

Authenticates against the specified domain name

Parameters:

domainName - the domain name to authenticate against

Returns:

self for method chaining

domainId

@Deprecated
IOSClientBuilder.V3 domainId(String domainId)

Deprecated.

DEPRECATED: Please use credentials(String, String, Identifier)

Authenticates against the specified domain identifier

Parameters:

domainId - the domain identifier to authenticate against

Returns:

self for method chaining

token

IOSClientBuilder.V3 token(String tokenId)

A token object. With token authentication, the id uniquely identifies the token. This method is typically used in combination with a request to change authorization scope

Parameters:

tokenId - the token identifier

Returns:

self for method chaining

scopeToProject

IOSClientBuilder.V3 scopeToProject(Identifier project,
                                   Identifier domain)

Scopes the token to a project level

Parameters:

project - the project ID or Name value

domain - the domain ID or Name value

Returns:

self for method chaining

scopeToProject

IOSClientBuilder.V3 scopeToProject(Identifier project)

scopes the token to a project level

Parameters:

project - the project id

Returns:

self for method chaining

scopeToDomain

IOSClientBuilder.V3 scopeToDomain(Identifier domain)

Scopes the token to a domain level

Parameters:

domain - the domain ID or Name value

Returns:

self for method chaining