com.softlayer.api.service.user.customer.external.Binding Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.user.customer.external;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.user.Customer;
import java.util.concurrent.Future;

/**
 * The SoftLayer_User_Customer_External_Binding data type contains general information for a single external binding.  This includes the 3rd party vendor, type of binding, and a unique identifier and password that is used to authenticate against the 3rd party service. 
 *
 * @see SoftLayer_User_Customer_External_Binding
 */
@ApiType("SoftLayer_User_Customer_External_Binding")
public class Binding extends com.softlayer.api.service.user.external.Binding {

    /**
     * The SoftLayer user that the external authentication binding belongs to.
     */
    @ApiProperty
    protected Customer user;

    public Customer getUser() {
        return user;
    }

    public void setUser(Customer user) {
        this.user = user;
    }

    public Service asService(ApiClient client) {
        return service(client, id);
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    /**
     * <<<
     *
     * @see SoftLayer_User_Customer_External_Binding
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_User_Customer_External_Binding")
    public static interface Service extends com.softlayer.api.service.user.external.Binding.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal. 

         * 

         * You may supply one of the following reason when you disable an external binding: 

         * *Unspecified

         * *TemporarilyUnavailable

         * *Lost

         * *Stolen
         *
         * @see SoftLayer_User_Customer_External_Binding::disable
         */
        @ApiMethod(instanceRequired = true)
        public Boolean disable(String reason);

        /**
         * Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal. 

         * 

         * Please note that API access will be disabled for users that have an active external binding. 
         *
         * @see SoftLayer_User_Customer_External_Binding::enable
         */
        @ApiMethod(instanceRequired = true)
        public Boolean enable();

        /**
         * @see SoftLayer_User_Customer_External_Binding::getObject
         */
        @ApiMethod(value = "getObject", instanceRequired = true)
        public Binding getObjectForBinding();

        /**
         * The SoftLayer user that the external authentication binding belongs to.
         *
         * @see SoftLayer_User_Customer_External_Binding::getUser
         */
        @ApiMethod(instanceRequired = true)
        public Customer getUser();

    }

    public static interface ServiceAsync extends com.softlayer.api.service.user.external.Binding.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#disable}
         */
        public Future disable(String reason);

        public Future disable(String reason, ResponseHandler callback);

        /**
         * Async version of {@link Service#enable}
         */
        public Future enable();

        public Future enable(ResponseHandler callback);

        /**
         * Async version of {@link Service#getObjectForBinding}
         */
        public Future getObjectForBinding();

        public Future getObjectForBinding(ResponseHandler callback);

        /**
         * Async version of {@link Service#getUser}
         */
        public Future getUser();

        /**
         * Async callback version of {@link Service#getUser}
         */
        public Future getUser(ResponseHandler callback);

    }

    public static class Mask extends com.softlayer.api.service.user.external.Binding.Mask {

        public com.softlayer.api.service.user.Customer.Mask user() {
            return withSubMask("user", com.softlayer.api.service.user.Customer.Mask.class);
        }

    }

}