/*
* Copyright 2016-2020 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
*
* https://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 org.springframework.credhub.support.password;
import org.springframework.credhub.support.CredentialRequest;
import org.springframework.credhub.support.CredentialType;
import org.springframework.util.Assert;
/**
* The details of a request to write a new or update an existing
* {@link PasswordCredential} in CredHub.
*
* @author Scott Frederick
*/
public class PasswordCredentialRequest extends CredentialRequest<PasswordCredential> {
/**
* Initialize a {@link CredentialRequest}.
*/
PasswordCredentialRequest() {
super(CredentialType.PASSWORD);
}
/**
* Create a builder that provides a fluent API for providing the values required to
* construct a {@link PasswordCredentialRequest}.
* @return a builder
*/
public static PasswordCredentialRequestBuilder builder() {
return new PasswordCredentialRequestBuilder();
}
/**
* A builder that provides a fluent API for constructing
* {@link PasswordCredentialRequest}s.
*/
public static class PasswordCredentialRequestBuilder extends
CredHubRequestBuilder<PasswordCredential, PasswordCredentialRequest, PasswordCredentialRequestBuilder> {
@Override
protected PasswordCredentialRequest createTarget() {
return new PasswordCredentialRequest();
}
@Override
protected PasswordCredentialRequestBuilder createBuilder() {
return this;
}
/**
* Set the value of a password credential.
* @param value the credential value; must not be {@literal null}
* @return the builder
*/
public PasswordCredentialRequestBuilder value(PasswordCredential value) {
Assert.notNull(value, "value must not be null");
this.targetObj.setValue(value);
return this;
}
/**
* Set the value of a password credential.
* @param value the credential value; must not be {@literal null}
* @return the builder
*/
public PasswordCredentialRequestBuilder value(String value) {
value(new PasswordCredential(value));
return this;
}
}
}
