com.stormpath.sdk.authc.UsernamePasswordRequest Maven / Gradle / Ivy
/*
* Copyright 2013 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.authc;
import com.stormpath.sdk.directory.AccountStore;
import com.stormpath.sdk.lang.Assert;
import com.stormpath.sdk.lang.Classes;
/**
*
* NOTE: This class has been deprecated and will be removed in version 1.0. Use the
* {@link UsernamePasswordRequests#builder() UsernamePasswordRequests.builder()} instead. For example:
*
* AuthenticationRequest request = UsernamePasswordRequests.builder()
* .setUsernameOrEmail(username)
* .setPassword(submittedRawPlaintextPassword)
* .build();
* Account authenticated = application.authenticateAccount(request).getAccount();
*
*
* A {@code UsernamePasswordRequest} is an {@code AuthenticationRequest} that represents a username (or email) +
* password pair. It optionally supports
* {@link #setAccountStore(com.stormpath.sdk.directory.AccountStore) targeting an specific account store} as well for
* customized authentication behavior.
*
* @see UsernamePasswordRequestBuilder
*
* @deprecated since 1.0.RC9. Use {@link UsernamePasswordRequests#builder() UsernamePasswordRequests.builder()} instead.
* @since 0.2
*/
@Deprecated
public class UsernamePasswordRequest implements AuthenticationRequest {
/**
* Returns a new {@link UsernamePasswordRequestBuilder} instance, used to construct username/password-based {@link AuthenticationRequest}s.
*
* @return a new {@link UsernamePasswordRequestBuilder} instance, used to construct username/password-based {@link AuthenticationRequest}s.
* @since 1.0.RC5
* @deprecated since 1.0.RC9. Use {@link UsernamePasswordRequests#builder() UsernamePasswordRequests.builder()} instead.
*/
@Deprecated
public static UsernamePasswordRequestBuilder builder() {
return (UsernamePasswordRequestBuilder) Classes.newInstance("com.stormpath.sdk.impl.authc.DefaultUsernamePasswordRequestBuilder");
}
/**
* Returns a new {@link BasicAuthenticationOptions} instance, that may be used to customize the {@link com.stormpath.sdk.authc.AuthenticationResult
* AuthenticationResult} resource that will be obtained after a successful authentication.
*
* @return a new {@link BasicAuthenticationOptions} instance, that may be used to customize the {@link com.stormpath.sdk.authc.AuthenticationResult
* AuthenticationResult} resource that will be obtained after a successful authentication.
* @see com.stormpath.sdk.authc.UsernamePasswordRequestBuilder#withResponseOptions(BasicAuthenticationOptions)
* @since 1.0.RC5
* @deprecated since 1.0.RC9. Use {@link UsernamePasswordRequests#options() UsernamePasswordRequests.options()} instead.
*/
@Deprecated
public static BasicAuthenticationOptions options() {
return (BasicAuthenticationOptions) Classes.newInstance("com.stormpath.sdk.impl.authc.DefaultBasicAuthenticationOptions");
}
private String username;
private char[] password;
private String host;
private AccountStore accountStore;
private BasicAuthenticationOptions authenticationOptions;
/**
* Constructs a new {@code UsernamePasswordRequest} with the specified {@code usernameOrEmail} and {@code password}.
*
* @param usernameOrEmail the account's username or email address
* @param password the account's raw password
* @see #UsernamePasswordRequest(String, String, AccountStore)
*/
@Deprecated
public UsernamePasswordRequest(String usernameOrEmail, String password) {
this(usernameOrEmail, password, null, null);
}
/**
* Constructs a new {@code UsernamePasswordRequest} with the specified {@code usernameOrEmail} and {@code password}.
*
* @param usernameOrEmail the account's username or email address
* @param password the account's raw password
* @see #UsernamePasswordRequest(String, String, AccountStore)
*/
@Deprecated
public UsernamePasswordRequest(String usernameOrEmail, char[] password) {
this(usernameOrEmail, password, null, null);
}
/**
* Constructs a new {@code UsernamePasswordRequest} with the specified {@code usernameOrEmail} and {@code password}
* for an end-user accessing the application from the specified {@code host}.
*
* @param usernameOrEmail the account's username or email address
* @param password the account's raw password
* @param host the host from where the end-user is accessing your application
* @see #UsernamePasswordRequest(String, String, String, AccountStore)
*/
@Deprecated
public UsernamePasswordRequest(String usernameOrEmail, String password, String host) {
this(usernameOrEmail, password, host, null);
}
/**
* Constructs a new {@code UsernamePasswordRequest} with the specified {@code usernameOrEmail} and {@code password}
* for an end-user accessing the application from the specified {@code host}.
*
* @param usernameOrEmail the account's username or email address
* @param password the account's raw password
* @param host the host from where the end-user is accessing your application
* @see #UsernamePasswordRequest(String, char[], String, AccountStore)
*/
@Deprecated
public UsernamePasswordRequest(String usernameOrEmail, char[] password, String host) {
this(usernameOrEmail, password, host, null);
}
/**
* Constructs a new {@code UsernamePasswordRequest} with the specified username (or email) and password, ensuring the
* authentication request will be directly targeted at the application's specified {@link AccountStore} (thereby
* bypassing the application's default
* account store authentication
* flow). The {@code AccountStore} must be assigned to the application sending the request.
* Usage
* Most applications will not need to specify an {@code AccountStore} during an authentication attempt, but
* specifying one can be useful in some cases, such as when an Application has many (dozens or hundreds) of
* assigned account stores: in this case specifying an account store will result in a direct (targeted)
* authentication which would be faster because
* Stormpath does not need to iteratively try each assigned account store
* as documented.
*
* @param usernameOrEmail the account's username or email address
* @param password the account's raw password
* @param accountStore an application's specific AccountStore that should process the authentication request,
* thereby bypassing the application's default
* account store authentication flow.
* @since 1.0.alpha
*/
@Deprecated
public UsernamePasswordRequest(String usernameOrEmail, String password, AccountStore accountStore) {
this(usernameOrEmail, password, null, accountStore);
}
/**
* Constructs a new {@code UsernamePasswordRequest} with the specified username (or email) and password, ensuring the
* authentication request will be directly targeted at the application's specified {@link AccountStore} (thereby
* bypassing the application's default
* account store authentication
* flow). The {@code AccountStore} must be assigned to the application sending the request.
* Usage
* Most applications will not need to specify an {@code AccountStore} during an authentication attempt, but
* specifying one can be useful in some cases, such as when an Application has many (dozens or hundreds) of
* assigned account stores: in this case specifying an account store will result in a direct (targeted)
* authentication which would be faster because
* Stormpath does not need to iteratively try each assigned account store
* as documented.
*
* @param usernameOrEmail the account's username or email address
* @param password the account's raw password
* @param accountStore an application's specific AccountStore that should process the authentication request,
* thereby bypassing the application's default
* account store authentication flow.
* @since 1.0.alpha
*/
@Deprecated
public UsernamePasswordRequest(String usernameOrEmail, char[] password, AccountStore accountStore) {
this(usernameOrEmail, password, null, accountStore);
}
/**
* Constructs a new {@code UsernamePasswordRequest} with the specified {@code usernameOrEmail} and {@code password}
* for an end-user accessing the application from the specified {@code host}, also ensuring the
* authentication request will be directly targeted at the application's specified {@link AccountStore} (thereby
* bypassing the application's default
* account store authentication
* flow). The {@code AccountStore} must be assigned to the application sending the request.
* Usage
* Most applications will not need to specify an {@code AccountStore} during an authentication attempt, but
* specifying one can be useful in some cases, such as when an Application has many (dozens or hundreds) of
* assigned account stores: in this case specifying an account store will result in a direct (targeted)
* authentication which would be faster because
* Stormpath does not need to iteratively try each assigned account store
* as documented.
*
* @param usernameOrEmail the account's username or email address
* @param password the account's raw password
* @param host the host from where the end-user is accessing your application
* @param accountStore an application's specific AccountStore that should process the authentication request,
* thereby bypassing the application's default
* account store authentication flow.
* @since 1.0.alpha
*/
@Deprecated
public UsernamePasswordRequest(String usernameOrEmail, String password, String host, AccountStore accountStore) {
this(usernameOrEmail, password != null ? password.toCharArray() : "".toCharArray(), host, accountStore);
}
/**
* Constructs a new {@code UsernamePasswordRequest} with the specified {@code usernameOrEmail} and {@code password}
* for an end-user accessing the application from the specified {@code host}, also ensuring the
* authentication request will be directly targeted at the application's specified {@link AccountStore} (thereby
* bypassing the application's default
* account store authentication
* flow). The {@code AccountStore} must be assigned to the application sending the request.
* Usage
* Most applications will not need to specify an {@code AccountStore} during an authentication attempt, but
* specifying one can be useful in some cases, such as when an Application has many (dozens or hundreds) of
* assigned account stores: in this case specifying an account store will result in a direct (targeted)
* authentication which would be faster because
* Stormpath does not need to iteratively try each assigned account store
* as documented.
*
* @param usernameOrEmail the account's username or email address
* @param password the account's raw password
* @param host the host from where the end-user is accessing your application
* @param accountStore an application's specific AccountStore that should process the authentication request,
* thereby bypassing the application's default
* account store authentication flow.
* @since 1.0.alpha
*/
@Deprecated
public UsernamePasswordRequest(String usernameOrEmail, char[] password, String host, AccountStore accountStore) {
this.username = usernameOrEmail;
this.password = password;
this.host = host;
this.accountStore = accountStore;
}
@Override
@Deprecated
public String getPrincipals() {
return username;
}
@Override
@Deprecated
public char[] getCredentials() {
return password;
}
@Override
@Deprecated
public String getHost() {
return this.host;
}
/**
* Returns a specific {@code AccountStore} that should process this authentication request, or {@code null} if the
* application's default account store
* authentication flow should execute. If non-null, the account store must be assigned to the application
* sending the request.
*
* This is an optional property, so the default is {@code null}, reflecting an application's default authentication
* flow.
* Usage
* Most applications will not need to specify an {@code AccountStore} during an authentication attempt, but
* specifying one can be useful in some cases, such as when an Application has many (dozens or hundreds) of
* assigned account stores: in this case specifying an account store will result in a direct (targeted)
* authentication which would be faster because
* Stormpath does not need to iteratively try each assigned account store
* as documented.
*
* @return a specific {@code AccountStore} that should process this authentication request, or {@code null} if the
* application's default
* account store authentication flow should execute. If non-null, the account store must be assigned
* to the application sending the request.
* @since 1.0.alpha
*/
@Override
@Deprecated
public AccountStore getAccountStore() {
return this.accountStore;
}
/**
* Sets a specific {@code AccountStore} that should process this authentication request, or {@code null} if the
* application's default account store
* authentication flow should execute. If non-null, the account store must be assigned to the application
* sending the request.
*
* This is an optional property, so the default is {@code null}, reflecting an application's default authentication
* flow.
* Usage
* Most applications will not need to specify an {@code AccountStore} during an authentication attempt, but
* specifying one can be useful in some cases, such as when an Application has many (dozens or hundreds) of
* assigned account stores: in this case specifying an account store will result in a direct (targeted)
* authentication which would be faster because
* Stormpath does not need to iteratively try each assigned account store
* as documented.
*
* @param accountStore a specific {@code AccountStore} that should process this authentication request, or
* {@code null} if the application's default
* account store
* authentication flow should execute. If non-null, the account store must be assigned
* to the application sending the request.
* @since 1.0.alpha
*/
@Deprecated
public void setAccountStore(AccountStore accountStore) {
Assert.notNull(accountStore, "accountStore cannot be null.");
this.accountStore = accountStore;
}
/**
* Ensures that when the response is obtained, it will be retrieved with the specified options. This enhances performance
* by leveraging a single request to retrieve multiple related resources you know you will use.
* For example,
* it can be used to have the {@link com.stormpath.sdk.account.Account Account} resource automatically expanded in the returned result.
*
*
* @param options the specific {@code BasicAuthenticationOptions} that will be used to customize the authentication response.
* @return this instance for method chaining.
* @since 1.0.RC5
*/
@Deprecated
public UsernamePasswordRequest setResponseOptions(BasicAuthenticationOptions options) {
this.authenticationOptions = options;
return this;
}
/**
* Returns the {@link BasicAuthenticationOptions} to be used in this request used to customize the response.
* For example,
* it can be used to have the {@link com.stormpath.sdk.account.Account Account} resource automatically expanded in the returned result.
*
*
* @return the {@code AuthenticationOptions} that will be used to customize the response.
* @since 1.0.RC5
*/
@Override
@Deprecated
public BasicAuthenticationOptions getResponseOptions() {
return this.authenticationOptions;
}
/**
* Clears out (nulls) the username, password, host, accountStore and options. The password bytes are explicitly set to
* 0x00 to eliminate the possibility of memory access at a later time.
*/
@Override
@Deprecated
public void clear() {
this.username = null;
this.host = null;
this.accountStore = null;
this.authenticationOptions = null;
char[] password = this.password;
this.password = null;
if (password != null) {
for (int i = 0; i < password.length; i++) {
password[i] = 0x00;
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy