com.softlayer.api.service.account.authentication.Saml 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
The newest version!
package com.softlayer.api.service.account.authentication;

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.Account;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.account.authentication.Attribute;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Future;

/**
 * @see SoftLayer_Account_Authentication_Saml
 */
@ApiType("SoftLayer_Account_Authentication_Saml")
public class Saml extends Entity {

    /**
     * The account associated with this saml configuration.
     */
    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

    public void setAccount(Account account) {
        this.account = account;
    }

    /**
     * The saml attribute values for a SoftLayer customer account.
     */
    @ApiProperty
    protected List attributes;

    public List getAttributes() {
        if (attributes == null) {
            attributes = new ArrayList();
        }
        return attributes;
    }

    /**
     * The saml account id.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String accountId;

    public String getAccountId() {
        return accountId;
    }

    public void setAccountId(String accountId) {
        accountIdSpecified = true;
        this.accountId = accountId;
    }

    protected boolean accountIdSpecified;

    public boolean isAccountIdSpecified() {
        return accountIdSpecified;
    }

    public void unsetAccountId() {
        accountId = null;
        accountIdSpecified = false;
    }

    /**
     * The identity provider x509 certificate.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String certificate;

    public String getCertificate() {
        return certificate;
    }

    public void setCertificate(String certificate) {
        certificateSpecified = true;
        this.certificate = certificate;
    }

    protected boolean certificateSpecified;

    public boolean isCertificateSpecified() {
        return certificateSpecified;
    }

    public void unsetCertificate() {
        certificate = null;
        certificateSpecified = false;
    }

    /**
     * The identity provider x509 certificate fingerprint.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String certificateFingerprint;

    public String getCertificateFingerprint() {
        return certificateFingerprint;
    }

    public void setCertificateFingerprint(String certificateFingerprint) {
        certificateFingerprintSpecified = true;
        this.certificateFingerprint = certificateFingerprint;
    }

    protected boolean certificateFingerprintSpecified;

    public boolean isCertificateFingerprintSpecified() {
        return certificateFingerprintSpecified;
    }

    public void unsetCertificateFingerprint() {
        certificateFingerprint = null;
        certificateFingerprintSpecified = false;
    }

    /**
     * The identity provider entity ID.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String entityId;

    public String getEntityId() {
        return entityId;
    }

    public void setEntityId(String entityId) {
        entityIdSpecified = true;
        this.entityId = entityId;
    }

    protected boolean entityIdSpecified;

    public boolean isEntityIdSpecified() {
        return entityIdSpecified;
    }

    public void unsetEntityId() {
        entityId = null;
        entityIdSpecified = false;
    }

    /**
     * The saml internal identifying number.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    /**
     * The service provider x509 certificate.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String serviceProviderCertificate;

    public String getServiceProviderCertificate() {
        return serviceProviderCertificate;
    }

    public void setServiceProviderCertificate(String serviceProviderCertificate) {
        serviceProviderCertificateSpecified = true;
        this.serviceProviderCertificate = serviceProviderCertificate;
    }

    protected boolean serviceProviderCertificateSpecified;

    public boolean isServiceProviderCertificateSpecified() {
        return serviceProviderCertificateSpecified;
    }

    public void unsetServiceProviderCertificate() {
        serviceProviderCertificate = null;
        serviceProviderCertificateSpecified = false;
    }

    /**
     * The service provider entity IDs.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String serviceProviderEntityId;

    public String getServiceProviderEntityId() {
        return serviceProviderEntityId;
    }

    public void setServiceProviderEntityId(String serviceProviderEntityId) {
        serviceProviderEntityIdSpecified = true;
        this.serviceProviderEntityId = serviceProviderEntityId;
    }

    protected boolean serviceProviderEntityIdSpecified;

    public boolean isServiceProviderEntityIdSpecified() {
        return serviceProviderEntityIdSpecified;
    }

    public void unsetServiceProviderEntityId() {
        serviceProviderEntityId = null;
        serviceProviderEntityIdSpecified = false;
    }

    /**
     * The service provider public key.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String serviceProviderPublicKey;

    public String getServiceProviderPublicKey() {
        return serviceProviderPublicKey;
    }

    public void setServiceProviderPublicKey(String serviceProviderPublicKey) {
        serviceProviderPublicKeySpecified = true;
        this.serviceProviderPublicKey = serviceProviderPublicKey;
    }

    protected boolean serviceProviderPublicKeySpecified;

    public boolean isServiceProviderPublicKeySpecified() {
        return serviceProviderPublicKeySpecified;
    }

    public void unsetServiceProviderPublicKey() {
        serviceProviderPublicKey = null;
        serviceProviderPublicKeySpecified = false;
    }

    /**
     * The service provider signle logout encoding.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String serviceProviderSingleLogoutEncoding;

    public String getServiceProviderSingleLogoutEncoding() {
        return serviceProviderSingleLogoutEncoding;
    }

    public void setServiceProviderSingleLogoutEncoding(String serviceProviderSingleLogoutEncoding) {
        serviceProviderSingleLogoutEncodingSpecified = true;
        this.serviceProviderSingleLogoutEncoding = serviceProviderSingleLogoutEncoding;
    }

    protected boolean serviceProviderSingleLogoutEncodingSpecified;

    public boolean isServiceProviderSingleLogoutEncodingSpecified() {
        return serviceProviderSingleLogoutEncodingSpecified;
    }

    public void unsetServiceProviderSingleLogoutEncoding() {
        serviceProviderSingleLogoutEncoding = null;
        serviceProviderSingleLogoutEncodingSpecified = false;
    }

    /**
     * The service provider signle logout address.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String serviceProviderSingleLogoutUrl;

    public String getServiceProviderSingleLogoutUrl() {
        return serviceProviderSingleLogoutUrl;
    }

    public void setServiceProviderSingleLogoutUrl(String serviceProviderSingleLogoutUrl) {
        serviceProviderSingleLogoutUrlSpecified = true;
        this.serviceProviderSingleLogoutUrl = serviceProviderSingleLogoutUrl;
    }

    protected boolean serviceProviderSingleLogoutUrlSpecified;

    public boolean isServiceProviderSingleLogoutUrlSpecified() {
        return serviceProviderSingleLogoutUrlSpecified;
    }

    public void unsetServiceProviderSingleLogoutUrl() {
        serviceProviderSingleLogoutUrl = null;
        serviceProviderSingleLogoutUrlSpecified = false;
    }

    /**
     * The service provider signle sign on encoding.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String serviceProviderSingleSignOnEncoding;

    public String getServiceProviderSingleSignOnEncoding() {
        return serviceProviderSingleSignOnEncoding;
    }

    public void setServiceProviderSingleSignOnEncoding(String serviceProviderSingleSignOnEncoding) {
        serviceProviderSingleSignOnEncodingSpecified = true;
        this.serviceProviderSingleSignOnEncoding = serviceProviderSingleSignOnEncoding;
    }

    protected boolean serviceProviderSingleSignOnEncodingSpecified;

    public boolean isServiceProviderSingleSignOnEncodingSpecified() {
        return serviceProviderSingleSignOnEncodingSpecified;
    }

    public void unsetServiceProviderSingleSignOnEncoding() {
        serviceProviderSingleSignOnEncoding = null;
        serviceProviderSingleSignOnEncodingSpecified = false;
    }

    /**
     * The service provider signle sign on address.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String serviceProviderSingleSignOnUrl;

    public String getServiceProviderSingleSignOnUrl() {
        return serviceProviderSingleSignOnUrl;
    }

    public void setServiceProviderSingleSignOnUrl(String serviceProviderSingleSignOnUrl) {
        serviceProviderSingleSignOnUrlSpecified = true;
        this.serviceProviderSingleSignOnUrl = serviceProviderSingleSignOnUrl;
    }

    protected boolean serviceProviderSingleSignOnUrlSpecified;

    public boolean isServiceProviderSingleSignOnUrlSpecified() {
        return serviceProviderSingleSignOnUrlSpecified;
    }

    public void unsetServiceProviderSingleSignOnUrl() {
        serviceProviderSingleSignOnUrl = null;
        serviceProviderSingleSignOnUrlSpecified = false;
    }

    /**
     * The identity provider single logout encoding.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String singleLogoutEncoding;

    public String getSingleLogoutEncoding() {
        return singleLogoutEncoding;
    }

    public void setSingleLogoutEncoding(String singleLogoutEncoding) {
        singleLogoutEncodingSpecified = true;
        this.singleLogoutEncoding = singleLogoutEncoding;
    }

    protected boolean singleLogoutEncodingSpecified;

    public boolean isSingleLogoutEncodingSpecified() {
        return singleLogoutEncodingSpecified;
    }

    public void unsetSingleLogoutEncoding() {
        singleLogoutEncoding = null;
        singleLogoutEncodingSpecified = false;
    }

    /**
     * The identity provider sigle logout address.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String singleLogoutUrl;

    public String getSingleLogoutUrl() {
        return singleLogoutUrl;
    }

    public void setSingleLogoutUrl(String singleLogoutUrl) {
        singleLogoutUrlSpecified = true;
        this.singleLogoutUrl = singleLogoutUrl;
    }

    protected boolean singleLogoutUrlSpecified;

    public boolean isSingleLogoutUrlSpecified() {
        return singleLogoutUrlSpecified;
    }

    public void unsetSingleLogoutUrl() {
        singleLogoutUrl = null;
        singleLogoutUrlSpecified = false;
    }

    /**
     * The identity provider single sign on encoding.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String singleSignOnEncoding;

    public String getSingleSignOnEncoding() {
        return singleSignOnEncoding;
    }

    public void setSingleSignOnEncoding(String singleSignOnEncoding) {
        singleSignOnEncodingSpecified = true;
        this.singleSignOnEncoding = singleSignOnEncoding;
    }

    protected boolean singleSignOnEncodingSpecified;

    public boolean isSingleSignOnEncodingSpecified() {
        return singleSignOnEncodingSpecified;
    }

    public void unsetSingleSignOnEncoding() {
        singleSignOnEncoding = null;
        singleSignOnEncodingSpecified = false;
    }

    /**
     * The identity provider signle sign on address.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String singleSignOnUrl;

    public String getSingleSignOnUrl() {
        return singleSignOnUrl;
    }

    public void setSingleSignOnUrl(String singleSignOnUrl) {
        singleSignOnUrlSpecified = true;
        this.singleSignOnUrl = singleSignOnUrl;
    }

    protected boolean singleSignOnUrlSpecified;

    public boolean isSingleSignOnUrlSpecified() {
        return singleSignOnUrlSpecified;
    }

    public void unsetSingleSignOnUrl() {
        singleSignOnUrl = null;
        singleSignOnUrlSpecified = false;
    }

    /**
     * A count of the saml attribute values for a SoftLayer customer account.
     */
    @ApiProperty
    protected Long attributeCount;

    public Long getAttributeCount() {
        return attributeCount;
    }

    public void setAttributeCount(Long attributeCount) {
        this.attributeCount = attributeCount;
    }

    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_Account_Authentication_Saml
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Account_Authentication_Saml")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * @see SoftLayer_Account_Authentication_Saml::createObject
         */
        @ApiMethod
        public Saml createObject(Saml templateObject);

        /**
         * @see SoftLayer_Account_Authentication_Saml::deleteObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean deleteObject();

        /**
         * Edit the object by passing in a modified instance of the object 
         *
         * @see SoftLayer_Account_Authentication_Saml::editObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean editObject(Saml templateObject);

        /**
         * This method will return the service provider metadata in XML format. 
         *
         * @see SoftLayer_Account_Authentication_Saml::getMetadata
         */
        @ApiMethod(instanceRequired = true)
        public String getMetadata();

        /**
         * @see SoftLayer_Account_Authentication_Saml::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Saml getObject();

        /**
         * The account associated with this saml configuration.
         *
         * @see SoftLayer_Account_Authentication_Saml::getAccount
         */
        @ApiMethod(instanceRequired = true)
        public Account getAccount();

        /**
         * The saml attribute values for a SoftLayer customer account.
         *
         * @see SoftLayer_Account_Authentication_Saml::getAttributes
         */
        @ApiMethod(instanceRequired = true)
        public List getAttributes();

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

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

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

        public Future createObject(Saml templateObject, ResponseHandler callback);

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

        public Future deleteObject(ResponseHandler callback);

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

        public Future editObject(Saml templateObject, ResponseHandler callback);

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

        public Future getMetadata(ResponseHandler callback);

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

        public Future getObject(ResponseHandler callback);

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

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

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

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

    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

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

        public Attribute.Mask attributes() {
            return withSubMask("attributes", Attribute.Mask.class);
        }

        public Mask accountId() {
            withLocalProperty("accountId");
            return this;
        }

        public Mask certificate() {
            withLocalProperty("certificate");
            return this;
        }

        public Mask certificateFingerprint() {
            withLocalProperty("certificateFingerprint");
            return this;
        }

        public Mask entityId() {
            withLocalProperty("entityId");
            return this;
        }

        public Mask id() {
            withLocalProperty("id");
            return this;
        }

        public Mask serviceProviderCertificate() {
            withLocalProperty("serviceProviderCertificate");
            return this;
        }

        public Mask serviceProviderEntityId() {
            withLocalProperty("serviceProviderEntityId");
            return this;
        }

        public Mask serviceProviderPublicKey() {
            withLocalProperty("serviceProviderPublicKey");
            return this;
        }

        public Mask serviceProviderSingleLogoutEncoding() {
            withLocalProperty("serviceProviderSingleLogoutEncoding");
            return this;
        }

        public Mask serviceProviderSingleLogoutUrl() {
            withLocalProperty("serviceProviderSingleLogoutUrl");
            return this;
        }

        public Mask serviceProviderSingleSignOnEncoding() {
            withLocalProperty("serviceProviderSingleSignOnEncoding");
            return this;
        }

        public Mask serviceProviderSingleSignOnUrl() {
            withLocalProperty("serviceProviderSingleSignOnUrl");
            return this;
        }

        public Mask singleLogoutEncoding() {
            withLocalProperty("singleLogoutEncoding");
            return this;
        }

        public Mask singleLogoutUrl() {
            withLocalProperty("singleLogoutUrl");
            return this;
        }

        public Mask singleSignOnEncoding() {
            withLocalProperty("singleSignOnEncoding");
            return this;
        }

        public Mask singleSignOnUrl() {
            withLocalProperty("singleSignOnUrl");
            return this;
        }

        public Mask attributeCount() {
            withLocalProperty("attributeCount");
            return this;
        }

    }

}