Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*******************************************************************************
* Copyright 2016 ContainX and OpenStack4j
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*******************************************************************************/
/*******************************************************************************
* Huawei has modified this source file.
* Copyright 2018 Huawei Technologies Co.,Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
* *******************************************************************************/
package com.huawei.openstack4j.api.client;
import com.huawei.openstack4j.api.OSClient.OSClientAKSK;
import com.huawei.openstack4j.api.OSClient.OSClientV2;
import com.huawei.openstack4j.api.OSClient.OSClientV3;
import com.huawei.openstack4j.api.exceptions.AuthenticationException;
import com.huawei.openstack4j.api.types.Facing;
import com.huawei.openstack4j.core.transport.Config;
import com.huawei.openstack4j.model.common.Identifier;
/**
* OpenStack4j Client Builder
*
* @author Jeremy Unruh
*
*/
public interface IOSClientBuilder> {
/**
* Associates the given configuration with this Client
*
* @param config OpenStack4j configuration options
* @return self for method chaining
*/
T withConfig(Config config);
/**
* The authentication credentials
*
* @param userId the user id to authenticate with
* @param password the password to authenticate with
* @return self for method chaining
*/
T credentials(String userId, String password);
/**
* The identity endpoint to connect to
*
* @param endpoint the endpoint URL of the identity service
* @return self for method chaining
*/
T endpoint(String endpoint);
/**
* The OpenStack cloud provider which helps determine compatibility within
* requests
*
* @param provider the cloud provider
* @return self for method chaining
*/
T provider(CloudProvider provider);
/**
* Allows for a specific network perspective to be used. For example to only
* use AdminURL Endpoints you would want to set the {@link Facing#ADMIN} as
* a facing perspective.
*
* NOTE: If you choose PUBLIC some features may not work that are normally
* admin based configuration/functionality. If you normally are not using
* these features PUBLIC works fine in most cases.
*
* @param perspective the network facing perspective
* @return self for method chaining
*/
T perspective(Facing perspective);
/**
* DEPRECATED: Use {@link #applyConfig(Config)} to configure SSL policies
*
* In some private environments self signed certificates are used. If you
* are using HTTPS and using self-signed cerificates then set this to true.
* Otherwise the default strict hostname and properly signed validation
* based client will be used.
*
* @param useNonStrictSSL true if an HTTPS self-signed environment
* @return self for method chaining
*/
@Deprecated
T useNonStrictSSLClient(boolean useNonStrictSSL);
/**
* Attempts to connect, authenticated and obtain an authorization access
* entity which contains a token, service catalog and endpoints from the
* controller. As a result a client will be returned encapsulating the
* authorized access and corresponding API access
*
* @return the authenticated client
* @throws AuthenticationException if the credentials or default tenant is
* invalid
*/
R authenticate() throws AuthenticationException;
/**
* OpenStack4j Client builder which authenticates against version V3
*/
public interface V2 extends IOSClientBuilder {
/**
* The tenant/project to authenticate as
*
* @param tenantName the tenant/project name
* @return self for method chaining
*/
V2 tenantName(String tenantName);
/**
* The tenant/project to authenticate as (some clouds such as HP use
* tenantId vs tenantName)
*
* @param tenantId the tenant/project id
* @return self for method chaining
*/
V2 tenantId(String tenantId);
/**
* Use Rackspace API Key Authentication Admin Extension to authenticate
*
* @param raxApiKey true if enabled
* @return self for method chaining
*/
V2 raxApiKey(boolean raxApiKey);
/**
* Allows authentication via an existing Token versus
* {@link #credentials(String, String)}. Note: The
* {@link #tenantId(String)} or {@link #tenantName(String)} will
* required when using this method for authentication.
*
* @param tokenId the token identifier
* @return self for method chaining
*/
V2 token(String tokenId);
}
/**
* OpenStack4j Client builder which authenticates against version V3
*/
public interface V3 extends IOSClientBuilder {
/**
* The authentication credentials and default scoped domain
*
* @param userName the user name to authenticate with
* @param password the password to authenticate with
* @param domain the domain if using "default scoped"
* @return self for method chaining
*/
V3 credentials(String userName, String password, Identifier domain);
/**
* DEPRECATED: Please use
* {@link #credentials(String, String, Identifier)
*
* Authenticates against the specified domain name
*
* @param domainName the domain name to authenticate against
* @return self for method chaining
*/
@Deprecated
V3 domainName(String domainName);
/**
* DEPRECATED: Please use
* {@link #credentials(String, String, Identifier)}
*
* Authenticates against the specified domain identifier
*
* @param domainId the domain identifier to authenticate against
* @return self for method chaining
*/
@Deprecated
V3 domainId(String domainId);
/**
* 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
*
* @param tokenId the token identifier
* @return self for method chaining
*/
V3 token(String tokenId);
/**
* Scopes the token to a project level
*
* @param project the project ID or Name value
* @param domain the domain ID or Name value
* @return self for method chaining
*/
V3 scopeToProject(Identifier project, Identifier domain);
/**
* scopes the token to a project level
*
* @param project the project id
* @return self for method chaining
*/
V3 scopeToProject(Identifier project);
/**
* Scopes the token to a domain level
*
* @param domain the domain ID or Name value
* @return self for method chaining
*/
V3 scopeToDomain(Identifier domain);
}
/**
* OpenStack4j Client builder which authenticates against version AKSK
*/
public interface AKSK extends IOSClientBuilder {
/**
* build method for {@link OSClientV4#credentials(String, String, String, String, String)}
*
* @param accessKey
* @param secretKey
* @param region
* @param projectId
* @param serviceDomainName
* @return
*/
AKSK credentials(String accessKey, String secretKey, String region, String projectId, String serviceDomainName);
}
}
