VersionSource.java

/*
Copyright (c) 2016 Red Hat, Inc.

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 org.ovirt.engine.api.restapi.invocation;

/**
 * This enumerated type is used to indicate where the API version has been extracted from.
 */
public enum VersionSource {
    /**
     * Indicates that the version hasn't been explicitly specified, so the default value has been used.
     */
    DEFAULT,

    /**
     * Indicates that the version has been extracted from the {@code Version} HTTP header.
     */
    HEADER,

    /**
     * Indicates that the version has been extracted from the the prefix of the URL, for example, if the request URI
     * contains a {@code v4} prefix like in {@code http://engine.example.com/ovirt-engine/api/v4/vms}.
     */
    URL,
}