com.softlayer.api.service.container.user.authentication.Token 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.container.user.authentication;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.user.Customer;

/**
 * Container class used to hold user authentication token 
 *
 * @see SoftLayer_Container_User_Authentication_Token
 */
@ApiType("SoftLayer_Container_User_Authentication_Token")
public class Token extends Entity {

    /**
     * hash that gets populated for user authentication
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String hash;

    public String getHash() {
        return hash;
    }

    public void setHash(String hash) {
        hashSpecified = true;
        this.hash = hash;
    }

    protected boolean hashSpecified;

    public boolean isHashSpecified() {
        return hashSpecified;
    }

    public void unsetHash() {
        hash = null;
        hashSpecified = false;
    }

    /**
     * the user authenticated object
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Customer user;

    public Customer getUser() {
        return user;
    }

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

    protected boolean userSpecified;

    public boolean isUserSpecified() {
        return userSpecified;
    }

    public void unsetUser() {
        user = null;
        userSpecified = false;
    }

    /**
     * the id of the user to authenticate
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long userId;

    public Long getUserId() {
        return userId;
    }

    public void setUserId(Long userId) {
        userIdSpecified = true;
        this.userId = userId;
    }

    protected boolean userIdSpecified;

    public boolean isUserIdSpecified() {
        return userIdSpecified;
    }

    public void unsetUserId() {
        userId = null;
        userIdSpecified = false;
    }

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

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

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

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

    }

}