/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.guacamole.vault.conf;

import java.util.Collection;

import org.apache.guacamole.form.Form;

/**
 * A service that exposes attributes for the admin UI, specific to the vault
 * implementation. Any vault implementation will need to expose the attributes
 * necessary for that implementation.
 */
public interface VaultAttributeService {

    /**
     * Return all custom connection attributes to be exposed through the
     * admin UI for the current vault implementation.
     *
     * @return
     *     All custom connection attributes to be exposed through the
     *     admin UI for the current vault implementation.
     */
    public Collection<Form> getConnectionAttributes();

    /**
     * Return all custom connection group attributes to be exposed through the
     * admin UI for the current vault implementation.
     *
     * @return
     *     All custom connection group attributes to be exposed through the
     *     admin UI for the current vault implementation.
     */
    public Collection<Form> getConnectionGroupAttributes();

    /**
     * Return all custom user attributes to be exposed through the admin UI for
     * the current vault implementation.
     *
     * @return
     *     All custom user attributes to be exposed through the admin UI for
     *     the current vault implementation.
     */
    public Collection<Form> getUserAttributes();

    /**
     * Return all user preference attributes to be exposed through the user
     * preferences UI for the current vault implementation.
     *
     * @return
     *     All user preference attributes to be exposed through the user
     *     preferences UI for the current vault implementation.
     */
    public Collection<Form> getUserPreferenceAttributes();
}
