com.vmware.photon.controller.model.adapterapi.EndpointConfigRequest Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2015-2016 VMware, Inc. All Rights Reserved.
 *
 * 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 com.vmware.photon.controller.model.adapterapi;

import java.util.List;
import java.util.Map;

import com.esotericsoftware.kryo.serializers.VersionFieldSerializer.Since;

import com.vmware.photon.controller.model.constants.ReleaseConstants;
import com.vmware.xenon.common.ServiceDocument.PropertyOptions;
import com.vmware.xenon.common.ServiceDocumentDescription.PropertyIndexingOption;

/**
 * Request to validate and/or enhance an Endpoint. The {@link ResourceRequest#resourceReference}
 * field is reference to the Endpoint to enhance.
 * 
 * If the value of {@link EndpointConfigRequest#requestType} is {@code RequestType#VALIDATE} then
 * value of {@link ResourceRequest#resourceReference} won't be set.
 */
public class EndpointConfigRequest extends ResourceRequest {

    public static final String USER_LINK_KEY = "userLink";
    public static final String USER_EMAIL_KEY = "userEmail";
    public static final String PRIVATE_KEY_KEY = "privateKey";
    public static final String PRIVATE_KEYID_KEY = "privateKeyId";
    public static final String PUBLIC_KEY_KEY = "publicKey";
    public static final String TOKEN_REFERENCE_KEY = "tokenReference";
    public static final String REGION_KEY = "regionId";
    public static final String ZONE_KEY = "zoneId";
    /**
     * A key for the property of {@link #endpointProperties} which specifies trusted certificate
     * for the endpoint
     */
    public static final String CERTIFICATE_PROP_NAME = "certificate";

    /**
     * A key for the property of {@link #endpointProperties} which specifies whether to accept or
     * not the certificate (if self-signed) for the endpoint
     */
    public static final String ACCEPT_SELFSIGNED_CERTIFICATE = "acceptSelfSignedCertificate";

    /**
     * Set this property to true if the end-point support public/global images enumeration.
     */
    public static final String SUPPORT_PUBLIC_IMAGES = "supportPublicImages";

    /**
     * Set this property to true if the end-point supports explicit datastores concept.
     */
    public static final String SUPPORT_DATASTORES = "supportDatastores";

    /**
     * Endpoint request type.
     */
    public enum RequestType {
        VALIDATE,
        ENHANCE
    }

    /**
     * Request type.
     */
    public RequestType requestType;

    /**
     * A map of value to use to validate and enhance Endpoint.
     */
    public Map endpointProperties;

    /**
     * A list of tenant links which can access this service.
     */
    @PropertyOptions(indexing = { PropertyIndexingOption.EXPAND })
    @Since(ReleaseConstants.RELEASE_VERSION_0_6_12)
    public List tenantLinks;
}