com.stormpath.sdk.challenge.Challenge Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stormpath-sdk-api Show documentation

The Stormpath Java SDK API .jar provides a Java API that your code can use to make calls to the Stormpath API. This .jar is the only compile-time dependency within the Stormpath SDK project that your code should depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.

The newest version!

/*
* Copyright 2016 Stormpath, Inc.
*
* 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.stormpath.sdk.challenge;

import com.stormpath.sdk.account.Account;
import com.stormpath.sdk.factor.Factor;
import com.stormpath.sdk.factor.sms.SmsFactor;
import com.stormpath.sdk.resource.Auditable;
import com.stormpath.sdk.resource.Deletable;
import com.stormpath.sdk.resource.Resource;
import com.stormpath.sdk.resource.Saveable;

/**
 * This domain object represents a challenge of a {@link Factor} for a Multi Factor Authentication.
 * 
 * In a Multi Factor Authentication scenario authenticating a user is challenged by additional {@link Factor}s like an {@link SmsFactor}.
 *
 * For Example: Using an {@link SmsFactor} as an additional {@link Factor} for authentication the user would receive an sms including a multi-digit code within its message.
 * The user would verify the authentication challenge by entering the sms code back to the system.
 *
 * @param  a subclass of {@link Factor} specifying the kind of Factor associated with this {@code Challenge}.
 * @param  a subclass of {@link Enum} specifying the status associated with this {@code Challenge}.
 *
 * @since 1.1.0
 */
public interface Challenge extends Resource, Saveable, Deletable, Auditable {

    /**
     * Returns the status of this challenge object
     *
     * @return status associated with this challenge
     */
    R getStatus();

    /**
     * Returns the account associated with this challenge
     *
     * @return account associated with this challenge
     */
    Account getAccount();

    /**
     * Sets the account associated with this challenge.
     *
     * @param account associated with this challenge.
     * @return this instance for method chaining.
     */
    Challenge setAccount(Account account);

    /**
     * Returns the factor associated with this challenge
     *
     * @return factor associated with this challenge
     */
    T getFactor();

    /**
     * Sets the factor associated with this challenge.
     *
     * @param factor associated with this challenge.
     * @return this instance for method chaining.
     */
    Challenge setFactor(T factor);

    /**
     * This is a convenience method to POST a code to an existing challenge resource in Stormpath for validation.
     * Returns true in case the challenge is validated with the given code
     * and false if otherwise.
     * Immediate Execution: Unlike other Challenge methods, you do not need to call {@link #save()}
     * {@link Challenge#getStatus()} method will return the submission status in the event of a failure.
     *
     * @parame code  The code to be validated with this challenge.
     * @return true in case the challenge is validated with the given code.
     */
    boolean validate(String code);
}