com.netflix.msl.entityauth.ProvisionedAuthenticationData Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of msl-core Show documentation
msl-core
There is a newer version: 1.2226.0
/**
 * Copyright (c) 2016-2017 Netflix, Inc.  All rights reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.netflix.msl.entityauth;

import com.netflix.msl.io.MslEncoderException;
import com.netflix.msl.io.MslEncoderFactory;
import com.netflix.msl.io.MslEncoderFormat;
import com.netflix.msl.io.MslObject;

/**
 * Provisioned entity authentication data. This form of authentication is
 * used by entities that cannot provide any form of entity authentication and
 * also want to delegate the generation or assignment of their identity to the
 * remote entity.
 * 
 * Provisioned entity authentication data is represented as
 * {@code
 * provisionedauthdata = {
 * }}
 * 
 * Until the entity identity has been provisioned, the entity identity will
 * be equal to the empty string.
 * 
 * @author Wesley Miaw 
 */
public class ProvisionedAuthenticationData extends EntityAuthenticationData {
    /**
     * Construct a new provisioned entity authentication data instance. 
     */
    public ProvisionedAuthenticationData() {
        super(EntityAuthenticationScheme.PROVISIONED);
    }
    
    /**
     * Construct a new provisioned entity authentication data instance from the
     * provided JSON object.
     * 
     * @param provisionedAuthMo the authentication data JSON object.
     */
    public ProvisionedAuthenticationData(final MslObject provisionedAuthMo) {
        super(EntityAuthenticationScheme.PROVISIONED);
    }
    
    /**
     * Sets the entity identity.
     * 
     * @param identity the entity identity.
     */
    void setIdentity(final String identity) {
        this.identity = identity;
    }
    
    /**
     * Return the entity identity. Prior to provisioning, this function will
     * return the empty string. After an identity has been provisioned, this
     * function will return the provisioned identity.
     * 
     * @see #setIdentity(String)
     */
    @Override
    public String getIdentity() {
        return identity;
    }

    @Override
    public MslObject getAuthData(final MslEncoderFactory encoder, final MslEncoderFormat format) throws MslEncoderException {
        return encoder.createObject();
    }
    
    /* (non-Javadoc)
     * @see com.netflix.msl.entityauth.EntityAuthenticationData#equals(java.lang.Object)
     */
    @Override
    public boolean equals(final Object obj) {
        if (obj == this) return true;
        if (!(obj instanceof ProvisionedAuthenticationData)) return false;
        return super.equals(obj);
    }
    
    /* (non-Javadoc)
     * @see com.netflix.msl.entityauth.EntityAuthenticationData#hashCode()
     */
    @Override
    public int hashCode() {
        return super.hashCode();
    }
    
    /** Entity identity. */
    private String identity = "";
}