io.restassured.config.OAuthConfig Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of rest-assured Show documentation
Show all versions of rest-assured Show documentation
Java DSL for easy testing of REST services
/*
* Copyright 2019 the original author or authors.
*
* 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 io.restassured.config;
/**
* Let's you configure OAuth specific configuration
*/
public class OAuthConfig implements Config {
private final boolean addEmptyAccessTokenToBaseString;
private final boolean isUserConfigured;
/**
* Create a new OAuthConfig that uses an OAuthToken
*/
public OAuthConfig() {
this(false, false);
}
private OAuthConfig(boolean addEmptyAccessTokenToBaseString, boolean isUserConfigured) {
this.addEmptyAccessTokenToBaseString = addEmptyAccessTokenToBaseString;
this.isUserConfigured = isUserConfigured;
}
/**
* Configure whether or not to add an empty oauth token for OAuth1 while generating Base string
*
* @param addEmptyAccessTokenToBaseString Whether or not to add an empty oauth access token parameter while generating base string
* @return A new instance of {@link OAuthConfig}
* @see #addEmptyAccessTokenToBaseString(boolean)
*/
public OAuthConfig addEmptyAccessTokenToBaseString(boolean addEmptyAccessTokenToBaseString) {
return new OAuthConfig(addEmptyAccessTokenToBaseString, true);
}
/**
* Returns whether or not add an empty oauth token for oauth1 while generating Base string.
*
* @return A new instance of {@link OAuthConfig}
*/
public boolean shouldAddEmptyAccessOAuthTokenToBaseString() {
return addEmptyAccessTokenToBaseString;
}
/**
* @return Whether or not this config is user configured.
*/
public boolean isUserConfigured() {
return isUserConfigured;
}
/**
* @return A static way to create a new OAuthConfig instance without calling "new" explicitly. Mainly for syntactic sugar.
*/
public static OAuthConfig oauthConfig() {
return new OAuthConfig();
}
/**
* Syntactic sugar.
*
* @return The same OAuthConfig instance.
*/
public OAuthConfig and() {
return this;
}
/**
* Syntactic sugar.
*
* @return The same OAuthConfig instance.
*/
public OAuthConfig with() {
return this;
}
}