org.mule.runtime.api.security.CredentialsBuilder Maven / Gradle / Ivy

Go to download

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

API for Mule Runtime

There is a newer version: 1.1.1

/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.runtime.api.security;

/**
 * Builder for a {@link Credentials} implementation.
 *
 * @since 1.0
 */
public interface CredentialsBuilder {

  /**
   * @param username the username of this {@link Credentials}
   * @return {@code this} builder
   */
  CredentialsBuilder withUsername(String username);

  /**
   * @param password the password of this {@link Credentials}
   * @return {@code this} builder
   */
  CredentialsBuilder withPassword(char[] password);

  /**
   * @param roles the enabled roles of this {@link Credentials}
   * @return {@code this} builder
   */
  CredentialsBuilder withRoles(Object roles);

  /**
   * @return an instance of a default implementation of {@link Credentials}
   */
  Credentials build();
}