com.vmware.avi.sdk.model.LdapUserBindSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of avisdk Show documentation
Avi SDK is a java API which creates a session with controller and perform CRUD operations.
There is a newer version: 31.1.1.RELEASE
/*
 * Copyright 2021 VMware, Inc.
 * SPDX-License-Identifier: Apache License 2.0
 */

package com.vmware.avi.sdk.model;

import java.util.*;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;

/**
 * The LdapUserBindSettings is a POJO class extends AviRestResource that used for creating
 * LdapUserBindSettings.
 *
 * @version 1.0
 * @since 
 *
 */
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
public class LdapUserBindSettings  {
    @JsonProperty("dn_template")
    private String dnTemplate;

    @JsonProperty("token")
    private String token = "";

    @JsonProperty("user_attributes")
    private List userAttributes;

    @JsonProperty("user_id_attribute")
    private String userIdAttribute;



    /**
     * This is the getter method this will return the attribute value.
     * Ldap user dn pattern is used to bind ldap user after replacing the user token with real username.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return dnTemplate
     */
    public String getDnTemplate() {
        return dnTemplate;
    }

    /**
     * This is the setter method to the attribute.
     * Ldap user dn pattern is used to bind ldap user after replacing the user token with real username.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param dnTemplate set the dnTemplate.
     */
    public void setDnTemplate(String  dnTemplate) {
        this.dnTemplate = dnTemplate;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Ldap token is replaced with real user name in the user dn pattern.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as "".
     * @return token
     */
    public String getToken() {
        return token;
    }

    /**
     * This is the setter method to the attribute.
     * Ldap token is replaced with real user name in the user dn pattern.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as "".
     * @param token set the token.
     */
    public void setToken(String  token) {
        this.token = token;
    }
    /**
     * This is the getter method this will return the attribute value.
     * Ldap user attributes to fetch on a successful user bind.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return userAttributes
     */
    public List getUserAttributes() {
        return userAttributes;
    }

    /**
     * This is the setter method. this will set the userAttributes
     * Ldap user attributes to fetch on a successful user bind.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return userAttributes
     */
    public void setUserAttributes(List  userAttributes) {
        this.userAttributes = userAttributes;
    }

    /**
     * This is the setter method this will set the userAttributes
     * Ldap user attributes to fetch on a successful user bind.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return userAttributes
     */
    public LdapUserBindSettings addUserAttributesItem(String userAttributesItem) {
      if (this.userAttributes == null) {
        this.userAttributes = new ArrayList();
      }
      this.userAttributes.add(userAttributesItem);
      return this;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Ldap user id attribute is the login attribute that uniquely identifies a single user record.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return userIdAttribute
     */
    public String getUserIdAttribute() {
        return userIdAttribute;
    }

    /**
     * This is the setter method to the attribute.
     * Ldap user id attribute is the login attribute that uniquely identifies a single user record.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param userIdAttribute set the userIdAttribute.
     */
    public void setUserIdAttribute(String  userIdAttribute) {
        this.userIdAttribute = userIdAttribute;
    }


    @Override
    public boolean equals(java.lang.Object o) {
      if (this == o) {
          return true;
      }
      if (o == null || getClass() != o.getClass()) {
          return false;
      }
      LdapUserBindSettings objLdapUserBindSettings = (LdapUserBindSettings) o;
      return   Objects.equals(this.dnTemplate, objLdapUserBindSettings.dnTemplate)&&
  Objects.equals(this.token, objLdapUserBindSettings.token)&&
  Objects.equals(this.userIdAttribute, objLdapUserBindSettings.userIdAttribute)&&
  Objects.equals(this.userAttributes, objLdapUserBindSettings.userAttributes);
    }

    @Override
    public String toString() {
      StringBuilder sb = new StringBuilder();
      sb.append("class LdapUserBindSettings {\n");
                  sb.append("    dnTemplate: ").append(toIndentedString(dnTemplate)).append("\n");
                        sb.append("    token: ").append(toIndentedString(token)).append("\n");
                        sb.append("    userAttributes: ").append(toIndentedString(userAttributes)).append("\n");
                        sb.append("    userIdAttribute: ").append(toIndentedString(userIdAttribute)).append("\n");
                  sb.append("}");
      return sb.toString();
    }

    /**
     * Convert the given object to string with each line indented by 4 spaces
     * (except the first line).
     */
    private String toIndentedString(java.lang.Object o) {
      if (o == null) {
          return "null";
      }
      return o.toString().replace("\n", "\n    ");
    }
}