001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.transport.wagon;
020
021import org.eclipse.aether.ConfigurationProperties;
022import org.eclipse.aether.RepositorySystemSession;
023
024/**
025 * A transporter using Maven Wagon.
026 */
027public final class WagonTransporterConfigurationKeys {
028    private WagonTransporterConfigurationKeys() {}
029
030    private static final String CONFIG_PROPS_PREFIX =
031            ConfigurationProperties.PREFIX_TRANSPORT + WagonTransporterFactory.NAME + ".";
032
033    /**
034     * The configuration to use for the Wagon provider.
035     *
036     * @configurationSource {@link RepositorySystemSession#getConfigProperties()}
037     * @configurationType {@link java.lang.Object}
038     * @configurationRepoIdSuffix Yes
039     */
040    public static final String CONFIG_PROP_CONFIG = CONFIG_PROPS_PREFIX + "config";
041
042    /**
043     * Octal numerical notation of permissions to set for newly created files. Only considered by certain Wagon
044     * providers.
045     *
046     * @configurationSource {@link RepositorySystemSession#getConfigProperties()}
047     * @configurationType {@link java.lang.String}
048     * @configurationRepoIdSuffix Yes
049     */
050    public static final String CONFIG_PROP_FILE_MODE = CONFIG_PROPS_PREFIX + "perms.fileMode";
051
052    /**
053     * Octal numerical notation of permissions to set for newly created directories. Only considered by certain
054     * Wagon providers.
055     *
056     * @configurationSource {@link RepositorySystemSession#getConfigProperties()}
057     * @configurationType {@link java.lang.String}
058     * @configurationRepoIdSuffix Yes
059     */
060    public static final String CONFIG_PROP_DIR_MODE = CONFIG_PROPS_PREFIX + "perms.dirMode";
061
062    /**
063     * Group which should own newly created directories/files. Only considered by certain Wagon providers.
064     *
065     * @configurationSource {@link RepositorySystemSession#getConfigProperties()}
066     * @configurationType {@link java.lang.String}
067     * @configurationRepoIdSuffix Yes
068     */
069    public static final String CONFIG_PROP_GROUP = CONFIG_PROPS_PREFIX + "perms.group";
070}