org.craftercms.profile.api.AccessToken Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of crafter-profile-api Show documentation
Crafter Profile API
There is a newer version: 4.3.1
package org.craftercms.profile.api;

import java.util.Date;
import java.util.List;

/**
 * Access token given to applications that need to access the REST API, acting for any tenant of a list.
 *
 * @author avasquez
 */
public class AccessToken {

    private String _id;
    private String application;
    private boolean master;
    private List tenantPermissions;
    private Date expiresOn;

    /**
     * Returns the ID of the access token.
     */
    public String getId() {
        return _id;
    }

    /**
     * Sets the ID of the access token.
     *
     * @param id    the token's ID
     */
    public void setId(String id) {
        this._id = id;
    }

    /**
     * Returns the name of the application accessing Crafter Profile.
     */
    public String getApplication() {
        return application;
    }

    /**
     * Sets the name of the application accessing Crafter Profile.
     *
     * @param application   the application name
     */
    public void setApplication(String application) {
        this.application = application;
    }

    /**
     * Returns true if this is a master token. A master token can be used to create and delete other tokens.
     */
    public boolean isMaster() {
        return master;
    }

    /**
     * Sets if this is a master token. A master token can be used to create and delete other tokens.
     *
     * @param master trues if this should be a master token, false otherwise
     */
    public void setMaster(boolean master) {
        this.master = master;
    }

    /**
     * Returns the tenant permissions the application has.
     */
    public List getTenantPermissions() {
        return tenantPermissions;
    }

    /**
     * Sets the he tenant permissions the application has.
     *
     * @param tenantPermissions the tenant permissions
     */
    public void setTenantPermissions(List tenantPermissions) {
        this.tenantPermissions = tenantPermissions;
    }

    /**
     * Returns the date of expiration of this token (when it becomes invalid)
     */
    public Date getExpiresOn() {
        return expiresOn;
    }

    /**
     * Sets the date of expiration of this token (when it becomes invalid)
     *
     * @param expiresOn the expiration date of the token
     */
    public void setExpiresOn(Date expiresOn) {
        this.expiresOn = expiresOn;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        AccessToken token = (AccessToken)o;

        return _id.equals(token._id);

    }

    @Override
    public int hashCode() {
        return _id.hashCode();
    }

    @Override
    public String toString() {
        return "AccessToken{" +
               "_id='" + _id + '\'' +
               ", application='" + application + '\'' +
               ", master=" + master +
               ", tenantPermissions=" + tenantPermissions +
               ", expiresOn=" + expiresOn +
               '}';
    }

}