com.huawei.openstack4j.openstack.OSFactory Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* 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.
*******************************************************************************/
package com.huawei.openstack4j.openstack;
import com.huawei.openstack4j.api.OSClient.OSClientV2;
import com.huawei.openstack4j.api.OSClient.OSClientV3;
import com.huawei.openstack4j.api.client.CloudProvider;
import com.huawei.openstack4j.api.client.IOSClientBuilder;
import com.huawei.openstack4j.api.exceptions.OS4JException;
import com.huawei.openstack4j.api.types.Facing;
import com.huawei.openstack4j.core.transport.Config;
import com.huawei.openstack4j.core.transport.internal.HttpLoggingFilter;
import com.huawei.openstack4j.model.common.Identifier;
import com.huawei.openstack4j.model.identity.v2.Access;
import com.huawei.openstack4j.model.identity.v3.Token;
import com.huawei.openstack4j.openstack.client.OSClientBuilder;
import com.huawei.openstack4j.openstack.identity.v3.domain.KeystoneAuth;
import com.huawei.openstack4j.openstack.identity.v3.domain.KeystoneAuth.AuthScope;
import com.huawei.openstack4j.openstack.internal.OSAuthenticator;
import com.huawei.openstack4j.openstack.internal.OSClientSession;
import com.huawei.openstack4j.openstack.internal.OSClientSession.OSClientSessionV2;
import com.huawei.openstack4j.openstack.internal.OSClientSessionV3;
/**
* A Factory which sets up the APIs to be used a previously non-expired authorization or new authorization.
*
* @author Jeremy Unruh
*/
public abstract class OSFactory> {
public OSFactory() { }
/**
* Skips Authentication and created the API around a previously cached Token object. This can be useful in multi-threaded environments
* or scenarios where a client should not be re-authenticated due to a token lasting 24 hours.
*
* @param token an authorized token entity which is to be used to create the API
* @return the OSClient
*/
public static OSClientV3 clientFromToken(Token token) {
return OSClientSessionV3.createSession(token);
}
/**
* Skips Authentication and created the API around a previously cached Token object. This can be useful in multi-threaded environments
* or scenarios where a client should not be re-authenticated due to a token lasting 24 hours
*
* @param token an authorized token entity which is to be used to create the API
* @param perspective the current endpoint perspective to use
* @return the OSClient
*/
public static OSClientV3 clientFromToken(Token token, Facing perspective) {
return OSClientSessionV3.createSession(token, perspective, null, null);
}
/**
* Skips Authentication and created the API around a previously cached Token object. This can be useful in multi-threaded environments
* or scenarios where a client should not be re-authenticated due to a token lasting 24 hours
*
* @param token an authorized token entity which is to be used to create the API
* @param config OpenStack4j configuration options
* @return the OSClient
*/
public static OSClientV3 clientFromToken(Token token, Config config) {
return OSClientSessionV3.createSession(token, null, null, config);
}
/**
* Skips Authentication and created the API around a previously cached Token object. This can be useful in multi-threaded environments
* or scenarios where a client should not be re-authenticated due to a token lasting 24 hours
*
* @param token an authorized token entity which is to be used to create the API
* @param perspective the current endpoint perspective to use
* @param config OpenStack4j configuration options
* @return the OSClient
*/
public static OSClientV3 clientFromToken(Token token, Facing perspective, Config config) {
return OSClientSessionV3.createSession(token, perspective, null, config);
}
/**
* Skips Authentication and created the API around a previously cached Token object. This can be useful in multi-threaded environments
* or scenarios where a client should not be re-authenticated due to a token lasting 24 hours
*
* @param token an authorized token entity which is to be used to create the API
* @param perspective the current endpoint perspective to use
* @param provider the cloud provider
* @param config OpenStack4j configuration options
* @return the OSClient
*/
public static OSClientV3 clientFromToken(Token token, Facing perspective, CloudProvider provider, Config config) {
return OSClientSessionV3.createSession(token, perspective, provider, config);
}
/**
* Skips Authentication and created the API around a previously cached Access object. This can be useful in multi-threaded environments
* or scenarios where a client should not be re-authenticated due to a token lasting 24 hours
*
* @param access an authorized access entity which is to be used to create the API
* @return the OSCLient
*/
public static OSClientV2 clientFromAccess(Access access) {
return OSClientSessionV2.createSession(access);
}
/**
* Skips Authentication and created the API around a previously cached Access object. This can be useful in multi-threaded environments
* or scenarios where a client should not be re-authenticated due to a token lasting 24 hours
*
* @param access an authorized access entity which is to be used to create the API
* @param perspective the current endpoint perspective to use
* @return the OSCLient
*/
public static OSClientV2 clientFromAccess(Access access, Facing perspective) {
return OSClientSessionV2.createSession(access, perspective, null, null);
}
/**
* Skips Authentication and created the API around a previously cached Access object. This can be useful in multi-threaded environments
* or scenarios where a client should not be re-authenticated due to a token lasting 24 hours
*
* @param access an authorized access entity which is to be used to create the API
* @param config OpenStack4j configuration options
* @return the OSCLient
*/
public static OSClientV2 clientFromAccess(Access access, Config config) {
return OSClientSessionV2.createSession(access, null, null, config);
}
/**
* Skips Authentication and created the API around a previously cached Access object. This can be useful in multi-threaded environments
* or scenarios where a client should not be re-authenticated due to a token lasting 24 hours
*
* @param access an authorized access entity which is to be used to create the API
* @param perspective the current endpoint perspective to use
* @param config OpenStack4j configuration options
* @return the OSCLient
*/
public static OSClientV2 clientFromAccess(Access access, Facing perspective, Config config) {
return OSClientSessionV2.createSession(access, perspective, null, config);
}
/**
* Skips Authentication and created the API around a previously cached Access object. This can be useful in multi-threaded environments
* or scenarios where a client should not be re-authenticated due to a token lasting 24 hours
*
* @param access an authorized access entity which is to be used to create the API
* @param perspective the current endpoint perspective to use
* @param provider the cloud provider
* @param config OpenStack4j configuration options
* @return the OSCLient
*/
public static OSClientV2 clientFromAccess(Access access, Facing perspective, CloudProvider provider, Config config) {
return OSClientSessionV2.createSession(access, perspective, provider, config);
}
/**
* Globally enables or disables verbose HTTP Request and Response logging useful for debugging
* @param enabled true to enable, false to enable
*/
public static void enableHttpLoggingFilter(boolean enabled) {
System.getProperties().setProperty(HttpLoggingFilter.class.getName(), String.valueOf(enabled));
}
/**
* Creates builder for OpenStack V2 based authentication
* @return V2 Authentication builder
*/
public static IOSClientBuilder.V2 builderV2() {
return new OSClientBuilder.ClientV2();
}
/**
* Creates builder for OpenStack V3 based authentication
* @return V3 Authentication builder
*/
public static IOSClientBuilder.V3 builderV3() {
return new OSClientBuilder.ClientV3();
}
public static IOSClientBuilder.AKSK builderAKSK() {
return new OSClientBuilder.ClientAKSK();
}
public static IOSClientBuilder.TempAKSK builderTempAKSK() {
return new OSClientBuilder.ClientTempAKSK();
}
/**
* do refresh token by your self
*
*/
public static void refreshToken() {
OSClientSession session = OSClientSession.getCurrent();
if (null == session){
throw new OS4JException("client not initialized.");
}
if (session instanceof OSClientSessionV3) {
OSAuthenticator.reAuthenticate();
}else{
throw new OS4JException("refresh token can only support token authenticate.");
}
}
}